1N1nce
IoT Integrator

Get single device action request

Get details about the device action request.

get/v1/integrate/devices/actions/requests/{requestId}

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Path parameters

requestIdstring required
Example:<request_id>

ID of device action request

Response

OK

idstring required

The ID of the request.

status'SCHEDULED' | 'IN_PROGRESS' | 'FAILED' | 'SUCCEEDED' | 'CANCELLED' required

The status of the request.

deviceIdstring required

The unique ID of the device.

ipstring required

The IP address of the device.

protocolstring required

The protocol of the request.

createdstring date-time required

The timestamp at which the request was created.

updatedstring date-time required

The timestamp at which the request was updated.

mode'SEND_NOW' | 'SEND_WHEN_ACTIVE' required

The mode of the request.

resultDataobject

Result data (can include response from device etc.).

requestDataobject

Protocol specific request data.

sendAttemptsLeftnumber

How many attempts are left to send data to the device

sendAttemptsnumber

The maximum number of attempts to send data to a device

Example response

{
  "id": "<request_id>",
  "status": "IN_PROGRESS",
  "deviceId": "<device_id>",
  "ip": "x.x.x.x",
  "protocol": "LWM2M",
  "mode": "SEND_NOW",
  "sendAttemptsLeft": 1,
  "sendAttempts": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.