GET api/v1/cami/measurement/{operation}/{typeId}/period?Value={Value}&Type={Type}&GroupedBy={GroupedBy}&Order={Order}&Offset={Offset}

Gets a collection of measurements based on query for a period

Request Information

Headers

URI Parameters

NameDescriptionTypeAdditional information
operation

The operation. { value, avg, max, min }

string

Required

typeId

The type identifier of the measurement

MeasurementType

Required

Value

The value of the period

integer

Required

Type

The type of the period

PeriodType

Required

GroupedBy

{Optional} - Defined the grouping used by the operation.

GroupedBy

None.

Order

{Optional} - Order of the data based on timestamp. Default set to ascending.

string

None.

Offset

{Optional} - Return timestamp with calculated offset, defaul = false.

boolean

None.

Body Parameters

None.

Response Information

Headers

Resource Description

Collection of measurements

Collection of MeasurementWithTimestamp
NameDescriptionTypeAdditional information
Timestamp

The timestamp of the measurement.

string

Required

TypeId

The type identifier for the measurement

MeasurementType

Required

Value

Value of the measurement

string

Required

UnitCode

Unit code of the measurement

UnitCode

Required

Response Formats

application/json

Sample:
[
  {
    "Timestamp": "sample string 1",
    "TypeId": 68185,
    "Value": "sample string 2",
    "UnitCode": 262656
  },
  {
    "Timestamp": "sample string 1",
    "TypeId": 68185,
    "Value": "sample string 2",
    "UnitCode": 262656
  }
]