latestOpenAPI 3.0.12026-08-103995881.2 MB
053edab62415
measurement_series
List a Measurement series
get/app/v1/measurement_series
Query parameters
page_sizenumber
page size
pagenumber
page number
sort_by'device_name' | 'description'
sort by
sort_direction'asc' | 'desc'
sort direction
measurement_series_idsstring
a comma-separated list of measurement series ids
measurement_series_descriptionstring
String to search for in measurement series descriptions
measurement_series_device_namestring
String to search for in device names
measurement_series_device_idstring uuid
UUID of the device to filter on
subject_idstring uuid
ID of the entity you want to list the measurements for
subject_type'equipment' | 'device' | 'facility' | 'flow' | 'asset_group'
Type of the entity you want to list the measurements for. Required if ID is defined.
event_idstring uuid
Event ID
Response
successful operation
Example response
{
"page_size": 10,
"total_entries": 58,
"total_pages": 6,
"data": [
{
"measurement_type": "volume",
"unit": "bbl",
"device": {
"attributes": {
"height": 10,
"location": [
43.65107,
-79.347015
],
"provider": "provider"
},
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"facility": {
"id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
"name": "Facility 1"
},
"measurement_types": [
"volume"
],
"facility_name": "Facility Name"
},
"measurement_type_name": "Wind Variation"
}
]
}