Skip to main content
API docs by Redocly

SensorThings v1.1 (1.0.0)

Download OpenAPI specification:Download

Version v1.1 of the OGC SensorThings API, including Part 2 - Tasking.

/v1.1/Actuators

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Actuators({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "metadata": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Actuators({entityId})/TaskingCapabilities

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Datastreams

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Datastreams({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "ObservedProperty": {
    },
  • "ObservedProperty@iot.navigationLink": "string",
  • "Sensor": {
    },
  • "Sensor@iot.navigationLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "name": "string",
  • "observationType": "string",
  • "observedArea": { },
  • "phenomenonTime": "string",
  • "properties": { },
  • "resultTime": "string",
  • "unitOfMeasurement": {
    }
}

/v1.1/Datastreams({entityId})/Observations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Datastreams({entityId})/ObservedProperty

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "definition": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Datastreams({entityId})/Sensor

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "metadata": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Datastreams({entityId})/Thing

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/FeaturesOfInterest

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/FeaturesOfInterest({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "feature": { },
  • "name": "string",
  • "properties": { }
}

/v1.1/FeaturesOfInterest({entityId})/Observations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/HistoricalLocations

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/HistoricalLocations({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "time": "2019-08-24T14:15:22Z"
}

/v1.1/HistoricalLocations({entityId})/Locations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/HistoricalLocations({entityId})/Thing

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Locations

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Locations({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Things": [
    ],
  • "Things@iot.count": 0,
  • "Things@iot.navigationLink": "string",
  • "Things@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "location": { },
  • "name": "string",
  • "properties": { }
}

/v1.1/Locations({entityId})/HistoricalLocations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Locations({entityId})/Things

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/MultiDatastreams

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/MultiDatastreams({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "@iot.selfLink": "string",
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "ObservedProperties": [
    ],
  • "ObservedProperties@iot.count": 0,
  • "ObservedProperties@iot.navigationLink": "string",
  • "ObservedProperties@iot.nextLink": "string",
  • "Sensor": {
    },
  • "Sensor@iot.navigationLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "multiObservationDataTypes": "string",
  • "name": "string",
  • "observationType": "string",
  • "observedArea": { },
  • "phenomenonTime": "string",
  • "properties": { },
  • "resultTime": "string",
  • "unitOfMeasurements": [
    ]
}

/v1.1/MultiDatastreams({entityId})/Observations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/MultiDatastreams({entityId})/ObservedProperties

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/MultiDatastreams({entityId})/Sensor

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "metadata": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/MultiDatastreams({entityId})/Thing

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Observations

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Observations({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastream": {
    },
  • "Datastream@iot.navigationLink": "string",
  • "FeatureOfInterest": {
    },
  • "FeatureOfInterest@iot.navigationLink": "string",
  • "MultiDatastream": {
    },
  • "MultiDatastream@iot.navigationLink": "string",
  • "parameters": { },
  • "phenomenonTime": "string",
  • "result": null,
  • "resultQuality": { },
  • "resultTime": "2019-08-24T14:15:22Z",
  • "validTime": "string"
}

/v1.1/Observations({entityId})/Datastream

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "ObservedProperty": {
    },
  • "ObservedProperty@iot.navigationLink": "string",
  • "Sensor": {
    },
  • "Sensor@iot.navigationLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "name": "string",
  • "observationType": "string",
  • "observedArea": { },
  • "phenomenonTime": "string",
  • "properties": { },
  • "resultTime": "string",
  • "unitOfMeasurement": {
    }
}

/v1.1/Observations({entityId})/FeatureOfInterest

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "feature": { },
  • "name": "string",
  • "properties": { }
}

/v1.1/Observations({entityId})/MultiDatastream

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "@iot.selfLink": "string",
  • "Observations": [
    ],
  • "Observations@iot.count": 0,
  • "Observations@iot.navigationLink": "string",
  • "Observations@iot.nextLink": "string",
  • "ObservedProperties": [
    ],
  • "ObservedProperties@iot.count": 0,
  • "ObservedProperties@iot.navigationLink": "string",
  • "ObservedProperties@iot.nextLink": "string",
  • "Sensor": {
    },
  • "Sensor@iot.navigationLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "multiObservationDataTypes": "string",
  • "name": "string",
  • "observationType": "string",
  • "observedArea": { },
  • "phenomenonTime": "string",
  • "properties": { },
  • "resultTime": "string",
  • "unitOfMeasurements": [
    ]
}

/v1.1/ObservedProperties

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/ObservedProperties({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "definition": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/ObservedProperties({entityId})/Datastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/ObservedProperties({entityId})/MultiDatastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Sensors

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Sensors({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "metadata": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Sensors({entityId})/Datastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Sensors({entityId})/MultiDatastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/TaskingCapabilities

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/TaskingCapabilities({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Actuator": {
    },
  • "Actuator@iot.navigationLink": "string",
  • "Tasks": [
    ],
  • "Tasks@iot.count": 0,
  • "Tasks@iot.navigationLink": "string",
  • "Tasks@iot.nextLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { },
  • "taskingParameters": { }
}

/v1.1/TaskingCapabilities({entityId})/Actuator

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "encodingType": "string",
  • "metadata": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/TaskingCapabilities({entityId})/Tasks

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/TaskingCapabilities({entityId})/Thing

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Tasks

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Tasks({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "TaskingCapability": {
    },
  • "TaskingCapability@iot.navigationLink": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "taskingParameters": { }
}

/v1.1/Tasks({entityId})/TaskingCapability

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Actuator": {
    },
  • "Actuator@iot.navigationLink": "string",
  • "Tasks": [
    ],
  • "Tasks@iot.count": 0,
  • "Tasks@iot.navigationLink": "string",
  • "Tasks@iot.nextLink": "string",
  • "Thing": {
    },
  • "Thing@iot.navigationLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { },
  • "taskingParameters": { }
}

/v1.1/Things

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Things({entityId})

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

Responses

Response samples

Content type
application/json
{
  • "@iot.id": 0,
  • "Datastreams": [
    ],
  • "Datastreams@iot.count": 0,
  • "Datastreams@iot.navigationLink": "string",
  • "Datastreams@iot.nextLink": "string",
  • "HistoricalLocations": [
    ],
  • "HistoricalLocations@iot.count": 0,
  • "HistoricalLocations@iot.navigationLink": "string",
  • "HistoricalLocations@iot.nextLink": "string",
  • "Locations": [
    ],
  • "Locations@iot.count": 0,
  • "Locations@iot.navigationLink": "string",
  • "Locations@iot.nextLink": "string",
  • "MultiDatastreams": [
    ],
  • "MultiDatastreams@iot.count": 0,
  • "MultiDatastreams@iot.navigationLink": "string",
  • "MultiDatastreams@iot.nextLink": "string",
  • "TaskingCapabilities": [
    ],
  • "TaskingCapabilities@iot.count": 0,
  • "TaskingCapabilities@iot.navigationLink": "string",
  • "TaskingCapabilities@iot.nextLink": "string",
  • "description": "string",
  • "name": "string",
  • "properties": { }
}

/v1.1/Things({entityId})/Datastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Things({entityId})/HistoricalLocations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Things({entityId})/Locations

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Things({entityId})/MultiDatastreams

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}

/v1.1/Things({entityId})/TaskingCapabilities

path Parameters
entityId
required
integer <int64>

The id of the requested entity

query Parameters
$skip
integer <int64>

The number of elements to skip from the collection

$top
integer <int64>

The number of elements to return

$count
boolean

Flag indicating if the total number of items in the collection should be returned.

$select
string

The list of properties that need to be returned.

$expand
string

The list of related queries that need to be included in the result.

$filter
string

A filter query.

Responses

Response samples

Content type
application/json
{
  • "@iot.count": 0,
  • "@iot.nextLink": "string",
  • "value": [
    ]
}