Request parameters: Sample Collections section
- Last UpdatedOct 04, 2022
- 1 minute read
Contains the set of sample collections.
<SampleCollections>
<SampleCollections>
<End>2018-08-18T01:10:00</End>
<IsDefined>True</IsDefined>
<SampleTypeCode>Boolean</SampleTypeCode>
<Samples>
<Sample>
<Quality>GoodNonspecific</Quality>
<TimeStamp>2018-08-18T01:06:00</TimeStamp>
<Value>True</Value>
</Sample>
<Sample>
<Quality>GoodNonspecific</Quality>
<TimeStamp>2018-08-18T01:08:00</TimeStamp>
<Value>True</Value>
</Sample>
</Samples>
<Start>2018-08-18T01:05:00</Start>
</SampleCollections>
</SampleCollections>
|
Parameter |
Description |
|
SampleCollections |
Contains the details of a sample collection. |
|
End |
The end date time of the data stream query. A valid datetime stamp. For example, 2018-06-24T18:00:00Z. |
|
IsDefined |
Specifies whether the stream is initialized and contains values. Can be True or False. |
|
SampleTypeCode |
The data type of the stream. For example, Unspecified, Boolean, Int32, Int64, Single, Double, String, DateTime, Event. |
|
Samples |
Contains the set of returned samples. |
|
Sample |
Contains the details of a single sample. |
|
Quality |
The data quality of the sample data. For more info, see Quality states. Value can be any of the possible Quality/Substatus values: GoodNonspecific, BadNotConnected, UncertainNonspecific. |
|
TimeStamp |
The timestamp of the sample data. For example, 2018-08-18T00:31:22.9234284Z. |
|
Value |
The data value of the sample. Some streams allow null values, depending on the data type. |
|
Start |
The start date time of the data stream query. This must be a valid datetime stamp. For example, 2018-08-24T12:00:00Z. |