GET api/v1/observation/value/{typeId}/taken?Value={Value}&Order={Order}&Offset={Offset}

Gets a collection of observations based on query for a period

Request Information

Headers

URI Parameters

NameDescriptionTypeAdditional information
typeId

The type identifier of the device type

DeviceType

Required

Value

Set the number of observation to retrieve

integer

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 observations

Collection of ObservationWithId
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

None.

Typeid

The type identifier for the observation

DeviceType

Required

Timestamp

Timestamp for when the observation are taken

string

Required

Inputtype

Input type used for the observation {AUTO, MANUAL, TEST}

string

Required

Source

string

None.

Equipmentid

{Optional} - Equipment identifier of the device used in the observation.

string

None.

Measurements

Collection of zero or more repetitions

Collection of Measurement

Required

Comment

{Optional} - A custom plain text comment belonging to the observation

string

None.

Contexts

{Optional} - Collection of zero or more repetitions

Collection of ContextInformation

None.