Skip to end of metadata
Go to start of metadata

Each thing can have events to handle a flow of datapoints.

Create datapoints


Fires event with specified datapoints.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

POST /<api-version>/things/<thingId>/events/<eventId>/datapoints.<format>?async=<async>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

eventIdxstring-Identifier of a event.

format

xstring-

Request/response format. Currently supported format is json.

async booleanfalsePerform operation asynchronously.

 

2. Request Body

Array of timestamp-values:

AttributeRequiredTypeDefaultInformation
atxstring-Datapoint timestamp, in ISO8601 format e.g. 2010-05-21T11:01:46Z.
value objectnullDatapoint value.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

3. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Update'.


4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

eventIdxstring-Identifier of a event.
async booleanfalsePerform operation asynchronously.
datapointsxarray-Array of datapoints
atxstring-Datapoint timestamp, in ISO8601 format e.g. 2010-05-21T11:01:46Z.
value objectnullDatapoint value.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Get datapoints by date range


Obtain datapoints of an event by date range.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/events/<eventId>/datapoints.<format>?start=<startTime>&end=<endTime>&limit=<limit>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.

format

xstring-

Request/response format. Currently supported format is json.

startxstring-Starting point of the query as a timestamp, e.g. 2010-05-20T11:01:46.000+0000.
endxstring-End point of the data returned as a timestamp, e.g. 2010-05-21T11:01:46.000+0000.
limit integer100Maximum number of datapoints to return.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

Array of timestamp-values:

AttributeRequiredTypeDefaultInformation
atxstring-Datapoint timestamp, in ISO8601 format e.g. 2010-05-21T11:01:46Z.
value objectnullDatapoint value.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client
thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.
startxstring-Starting point of the query as a timestamp, e.g. 2010-05-20T11:01:46Z.
endxstring-End point of the data returned as a timestamp, e.g. 2010-05-21T11:01:46Z.
limit integer100Maximum number of datapoints to return.


2. Response

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 
resultxarray-Array of datapoints
atxstring-Datapoint timestamp, in ISO8601 format e.g. 2010-05-21T11:01:46Z.
value objectnullDatapoint value.

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Get datapoint by timestamp


Obtain event datapoint value by timestamp.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/events/<eventId>/datapoints/<time>.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.
timexstring-Datapoint timestamp, e.g. 2010-05-20T11:01:46Z.

format

xstring-

Request/response format. Currently supported format is json.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

Datapoint value.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client
thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.
timexstring-Datapoint timestamp, e.g. 2010-05-20T11:01:46Z.


2. Response

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 
result objectnullDatapoint value.

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Update datapoint


Update event datapoint.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

PUT /<api-version>/things/<thingId>/events/<eventId>/datapoints/<timestamp>.<format>?async=<async>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

eventIdxstring-Identifier of a event.
timestampxstring Datapoint timestamp, e.g. 2010-05-21T11:01:46Z.

format

xstring-

Request/response format. Currently supported format is json.

async booleanfalsePerform operation asynchronously.

 

2. Request Body

New datapoint value:

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

3. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Update'.


4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

eventIdxstring-Identifier of a event.
timexstring-Datapoint timestamp, in ISO8601 format e.g. 2010-05-21T11:01:46Z
valuexobject-Datapoint value.
async booleanfalsePerform operation asynchronously.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Delete datapoints by date range / Delete all datapoints


Delete event datpoints.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

DELETE /<api-version>/things/<thingId>/events/<eventId>/datapoints.<format>?deleteAll=<deleteAll>&start=<start>&end=<end>&async=<async>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

eventIdxstring-Identifier of a event.

format

xstring-

Request/response format. Currently supported format is json.

deleteAllif "start" parameter is missingboolean-Delete all event datapoints.
startif "deleteAll" parameter is missingstring-Starting point of deletion as a timestamp, e.g. 2010-05-20T11:01:46Z.
endif "deleteAll" parameter is missingstring-End point of deletion as a timestamp, e.g. 2010-05-20T11:01:46Z.
async booleanfalsePerform operation asynchronously.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Update'.


3. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

eventIdxstring-Identifier of a event.
deleteAllif "start" parameter is missingboolean-Delete all event datapoints.
startif "deleteAll" parameter is missingstring-Starting point of deletion as a timestamp, e.g. 2010-05-20T11:01:46Z.
endif "deleteAll" parameter is missingstring-End point of deletion as a timestamp, e.g. 2010-05-20T11:01:46Z.
async booleanfalsePerform operation asynchronously.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Delete datapoint by timestamp


Delete event datapoint value by timestamp.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

DELETE /<api-version>/things/<thingId>/events/<eventId>/datapoints/<time>.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.
timexstring-Datapoint timestamp, e.g. 2010-05-20T11:01:46Z.

format

xstring-

Request/response format. Currently supported format is json.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client
thingIdxstring-Identifier of thing.
eventIdxstring-Identifier of event.
timexstring-Datapoint timestamp, e.g. 2010-05-20T11:01:46Z.


2. Response

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

 

  • No labels