Data REST API (1.0)

Download OpenAPI specification:Download

This API provides an interface to retrieve data.

Data REST API

Token

Get ID Token

Returns ID Token after successful authentication with Cognito

Request Body schema: application/json
required
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "IdToken": "string"
}

Asynchronous Alarm API

Start the data preparation for a date-time window. Method: 'GET with Body'

Request data preparation and start a query for the alarm data for a time range.

Authorizations:
cognitoUserPool
Request Body schema: application/json
optional
date_time_from
string <date-time>

Timestamp to define start point for data

date_time_until
string <date-time>

Timestamp to define end point for data

object

Additional options

Responses

Request samples

Content type
application/json
{
  • "date_time_from": "2019-08-24T14:15:22Z",
  • "date_time_until": "2019-08-24T14:15:22Z",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Submitted",
  • "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8"
}

CORS support

Enable CORS by returning correct headers

Responses

Get the status of request

Returns the status of the request with given uuid

Authorizations:
cognitoUserPool
path Parameters
request_uuid
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

UUID of the request

Responses

Response samples

Content type
application/json
{
  • "status": "Completed",
  • "data_urls": [ ],
  • "metadata_url": "string"
}

CORS support

Enable CORS by returning correct headers

Responses

Asynchronous Measurement API

Start the data preparation for a date-time window. Method: 'GET with Body'

Request data preparation and start a query for the measurement data for a time range.

Authorizations:
cognitoUserPool
Request Body schema: application/json
optional
date_time_from
string <date-time>

Timestamp to define start point for data

date_time_until
string <date-time>

Timestamp to define end point for data

object

Additional options

Responses

Request samples

Content type
application/json
{
  • "date_time_from": "2019-08-24T14:15:22Z",
  • "date_time_until": "2019-08-24T14:15:22Z",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Submitted",
  • "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8"
}

CORS support

Enable CORS by returning correct headers

Responses

Get the status of request

Returns the status of the request with given uuid

Authorizations:
cognitoUserPool
path Parameters
request_uuid
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

UUID of the request

Responses

Response samples

Content type
application/json
{
  • "status": "Completed",
  • "data_urls": [ ],
  • "metadata_url": "string"
}

CORS support

Enable CORS by returning correct headers

Responses

Asynchronous Executed Task API

Start the data preparation for a date-time window. Method: 'GET with Body'

Request data preparation and start a query for the executed tasks data for a time range.

Authorizations:
cognitoUserPool
Request Body schema: application/json
optional
date_time_from
string <date-time>

Timestamp to define start point for data

date_time_until
string <date-time>

Timestamp to define end point for data

object

Additional options

Responses

Request samples

Content type
application/json
{
  • "date_time_from": "2019-08-24T14:15:22Z",
  • "date_time_until": "2019-08-24T14:15:22Z",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Submitted",
  • "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8"
}

CORS support

Enable CORS by returning correct headers

Responses

Get the status of request

Returns the status of the request with given uuid

Authorizations:
cognitoUserPool
path Parameters
request_uuid
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

UUID of the request

Responses

Response samples

Content type
application/json
{
  • "status": "Completed",
  • "data_urls": [ ],
  • "metadata_url": "string"
}

CORS support

Enable CORS by returning correct headers

path Parameters
request_uuid
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

UUID of the request

Responses

Device Metadata REST API

Get list of all probes

Returns the list of all probes

Authorizations:
cognitoUserPool

Responses

Response samples

Content type
application/json
{
  • "probes": [
    ]
}

CORS support

Enable CORS by returning correct headers

Responses

Asynchronous Device Metadata API

Start the data preparation for device metadata

Request data preparation and start a query for device metadata.

Authorizations:
cognitoUserPool
Request Body schema: application/json
optional
object

Additional options

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Submitted",
  • "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8"
}

CORS support

Enable CORS by returning correct headers

Responses

Get the status of request

Returns the status of the request with given uuid

Authorizations:
cognitoUserPool

Responses

Response samples

Content type
application/json
{
  • "status": "Completed",
  • "data_urls": [ ],
  • "metadata_url": "string"
}

CORS support

Enable CORS by returning correct headers

Responses

Device Status REST API

Get list of all devices' status

Returns the list of devices' status

Authorizations:
cognitoUserPool

Responses

Response samples

Content type
application/json
{
  • "devices_status": [
    ],
  • "sensors_status": [
    ]
}

CORS support

Enable CORS by returning correct headers

Responses

Tenant REST API

Get list of all tenants

Returns the list of all tenants

Authorizations:
cognitoUserPool

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

CORS support

Enable CORS by returning correct headers

Responses

Equipment REST API

Get list of all equipments

Returns the list of all equipments

Authorizations:
cognitoUserPool

Responses

Response samples

Content type
application/json
{
  • "equipments": [
    ]
}

CORS support

Enable CORS by returning correct headers

Responses