Page History

Return scalar data from a specific Location.

• Location Code must be valid and match exactly, including case.
• Specific Location Codes can be obtained using the locations service.

Return scalar data belonging to a specific Device Category Code.

• Device Category Code must be valid and match exactly, including case.
• Specific Device Category Codes can be obtained using the deviceCategories service.

• Specific

• propertyCode can be obtained using

• the properties service.
• propertyCode
  • must be valid
  • exact match
  • is case sensistive

sensorCategoryCodes

Return scalar data that has a timestamp on or after a specific date/time.

Accepted DateTime formats:

• yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
  
• yyyy-MM-dd (ISO 8601 Extended)
  
• PnYnMnDTnHnMnS (ISO 8601 Duration)
  

If not specified, the default value is the beginning of time.

• DateTime is represented in Coordinated Universal Time (UTC).

• ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
• Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

dateFrom=2010-07-27T00:00:00.000Z

dateFrom=2010-07-27

dateFrom=-P1DT1H

• Previous 1 day and 1 hour, relative to the dateTo. Note the '-' before the P.

Return scalar data that has a timestamp before a specific date/time.

Accepted DateTime formats:

• yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
  
• yyyy-MM-dd (ISO 8601 Extended)
  
• PnYnMnDTnHnMnS (ISO 8601 Duration)
  

If not specified, the default value is the end of time.

• DateTime is represented in Coordinated Universal Time (UTC).

• ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
• Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

dateTo=2016-08-01T00:00:00.000Z

dateTo=2016-08-01

dateTo=PT12H30M

• Next 12 hours and 30 minutes, relative to the dateFrom.

There are two values:

• Minimum (default) (case insensitive)
  • provides only basic property information
• Full (case insensitive)
  • provides all property information

The metadata is for the latest deployment overlapping the time range specified by dateFrom and dateTo.

There are two values:

• Array (default) (case insensitive)
  
  • Data is output as three arrays for a given sensor: a sampleTime array, a values array, and a qaqcFlags array.
• Object (case insensitive)
  • Data is output as a list of objects for a given sensor. Inside each data object, there are sampleTime, value, and qaqcFlag lists.

Specifies whether or not the latest scalar data readings should be returned first. 

getLatest = false: default

getLatest = true: readings are returned and pagination is done from latest to earliest.

accepted values:

• raw
  • returns raw scalar data
• clean
  • returns clean scalar data

The default value when no qualityControl has been provided is: qualityControl = clean.

To get resampled data values: qualityControl = clean.

accepted values:

• avg
  • gets the average value in each resamplePeriod
• avgMinMax
  • gets the average, minimum, and maximum values in each resample period
• minMax
  • gets the minimum and maximum values in each resample period

The default value when no resampleType has been provided is: resampleType=avgMinMax.

The resmapleType option requires that a samplePeriod has been added

To resample clean scalar data the resample period is set in seconds. The resamplePeriod parameter is required for the resampleType parameter.

accepted values:

• 60 (1 Minute)
• 600 (10 Minutes)
• 900 (15 Minutes)
• 3600 (1 Hour)
• 86400 (1 Day)