Table of contents
Sensor Data
Download API definition:
POST https://qa-api.bentley.com/sensor-data/data/upload

Upload time-series sensor readings.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Upload observations endpoint

Request body

Observations

Name
Type
Required?
Description
observations
Object[]
No

Example

json
{
    "observations": [{
        "sensorId": "/api/023C74/node/dynamic/C137D3/device/D6FAC4/sensor",
        "timestamp": "2023-10-09T08:31:29Z",
        "values": {
            "raw_value": 10
        }
    }]
}

Response 202 Accepted

Request Accepted

json
{
    "status": "ACCEPTED"
}

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

Observations

Name
Type
Description
observations
Object[]

DataUploadResponse

Name
Type
Description
status
String

Error

Contains error information.

Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String, null

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

Name
Type
Description
error

Error information.