DUET PlatformDocs
API referenceRead APIStatus

List device status

planned

Planned

This endpoint isn't available yet. Until it is, it answers 501 Not Implemented.
GET
/platform/v1/devices/status

Lists the current status and operating state of every device in a project. Rows are ordered by device ID.

Authorization

Bearer
headerAuthorizationBearer <token>

Query Parameters

project_id*string

The ID of the project to read from.

site?string

Returns only devices at this site.

status?string

Returns only devices with this status.

Value in"normal""standby""communication_loss""out_of_service""fault""no_data"

Response Body

The device status rows, ordered by device ID.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/devices/status?project_id=string'
Example Response
[  {    "device_id": "string",    "device_name": "string",    "device_type": "string",    "parent_device_id": "string",    "site": "string",    "status": "normal",    "status_since": "2019-08-24T14:15:22Z",    "operating_state": "string",    "operating_state_raw": "string",    "operating_state_tag": "string",    "reason": "string",    "updated_at": "2019-08-24T14:15:22Z"  }]