Oracle Cloud Infrastructure Documentation / Data API Reference and Endpoints

Internet of Things Data API

API docs by Redocly

Internet of Things Data API (1.0.0)

Download OpenAPI specification:

Use the Internet of Things (IoT) Data API to get your digital twin data for an IoT domain. For more information, see Internet of Things documentation.

Data API Endpoints

  • https://{iotDomainGroupShortId}.data.iot.eu-frankfurt-1.oci.oraclecloud.com/ords/{iotDomainShortId}
  • https://{iotDomainGroupShortId}.data.iot.uk-london-1.oci.oraclecloud.com/ords/{iotDomainShortId}
  • https://{iotDomainGroupShortId}.data.iot.us-ashburn-1.oci.oraclecloud.com/ords/{iotDomainShortId}
  • https://{iotDomainGroupShortId}.data.iot.us-phoenix-1.oci.oraclecloud.com/ords/{iotDomainShortId}

List raw data

Retrieve collection of raw data received from IoT devices in the IoT domain.

Authorizations:
BearerAuth

Responses

Response samples

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

Get raw data by ID

Retrieve raw data received from IoT devices in the IoT domain.

Authorizations:
BearerAuth
path Parameters
id
required
string^[^/]+$

Record id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "digital_twin_instance_id": "string",
  • "endpoint": "http://example.com",
  • "content_type": "string",
  • "time_received": "2019-08-24T14:15:22Z",
  • "content": { }
}

List rejected data

Retrieve collection of records from IoT devices in the IoT domain that were rejected during normalization.

Authorizations:
BearerAuth

Responses

Response samples

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

Get rejected data by ID

Retrieve record from IoT devices in the IoT domain that were rejected during normalization.

Authorizations:
BearerAuth
path Parameters
id
required
string^[^/]+$

Record id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "digital_twin_instance_id": "string",
  • "endpoint": "http://example.com",
  • "content_type": "string",
  • "time_received": "2019-08-24T14:15:22Z",
  • "reason_code": 0,
  • "reason_message": "string",
  • "content": { }
}

List snapshot data

Retrieve records of the last known value of digital twin instances in the IoT domain.

Authorizations:
BearerAuth

Responses

Response samples

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

List historized data

Retrieve time-series data of the digital twin instances in the IoT domain, whose model content is marked as 'Historized'.

Authorizations:
BearerAuth

Responses

Response samples

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

Get historized data by ID

Retrieve a record of time-series data of the digital twin instances in the IoT domain, whose model content is marked as 'Historized'.

Authorizations:
BearerAuth
path Parameters
id
required
string^[^/]+$

Record id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "digital_twin_instance_id": "string",
  • "content_path": "string",
  • "value": null,
  • "time_observed": "2019-08-24T14:15:22Z"
}

List raw command data

Retrieve raw data commands sent to digital twin instances in the IoT domain.

Authorizations:
BearerAuth

Responses

Response samples

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

Get raw command data by ID

Retrieve a data record commands sent to digital twin instances in the IoT domain.

Authorizations:
BearerAuth
path Parameters
id
required
string^[^/]+$

Record id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "digital_twin_instance_id": "string",
  • "request_endpoint": "http://example.com",
  • "request_duration": "string",
  • "request_data_format": "TEXT",
  • "request_content_type": "string",
  • "response_endpoint": "http://example.com",
  • "response_duration": "string",
  • "response_data_format": "TEXT",
  • "response_content_type": "string",
  • "delivery_status": "ACCEPTED",
  • "created_by": "string",
  • "time_created": "2019-08-24T14:15:22Z",
  • "time_updated": "2019-08-24T14:15:22Z",
  • "time_finished": "2019-08-24T14:15:22Z",
  • "request_data": { },
  • "response_data": { }
}