DUET PlatformDocs
API referenceRead APIIssues and work orders

Get an issue

planned

Planned

This endpoint isn't available yet. Until it is, it answers 501 Not Implemented.
GET
/platform/v1/issues/{id}

Returns one issue, in the same shape as in the issue.* webhooks.

Authorization

Bearer
headerAuthorizationBearer <token>

Path Parameters

id*string

The DUET ID of the resource.

Query Parameters

project_id*string

The ID of the project that the resource belongs to.

Response Body

The issue.

application/json
  1. response

An issue, as it was when the change happened, with its devices and work orders.

id*string
number*integer
organization_id*string
project_id*string
project*
sentinel_tag*string
name*string
description*string|null
status*string

The issue status. An open set of values. resolved and closed are terminal. When the status moves into a terminal value, DUET sends issue.resolved. When it moves out of one, DUET sends issue.reopened.

priority*|

The priority. Null when no priority is set.

Value in"urgent""high""medium""low"
source*string

How the issue was raised, for example manual, import, detector, or alarm. An open set of values.

effective_from*|
Formatdate-time
effective_to*|
Formatdate-time
resolved_at*|
Formatdate-time
assigned_to*|

A DUET user.

created_by*|

The user who created the issue. Null when automation raised it.

devices*array<>
work_orders*array<>
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/issues/string?project_id=string'
Example Response
{  "id": "string",  "number": 0,  "organization_id": "string",  "project_id": "string",  "project": {    "key": "string"  },  "sentinel_tag": "string",  "name": "string",  "description": "string",  "status": "string",  "priority": "urgent",  "source": "string",  "effective_from": "2019-08-24T14:15:22Z",  "effective_to": "2019-08-24T14:15:22Z",  "resolved_at": "2019-08-24T14:15:22Z",  "assigned_to": {    "id": "string",    "first_name": "string",    "last_name": "string",    "email": "string"  },  "created_by": {    "id": "string",    "first_name": "string",    "last_name": "string",    "email": "string"  },  "devices": [    {      "device_id": "string",      "component": "string",      "effective_from": "2019-08-24T14:15:22Z",      "effective_to": "2019-08-24T14:15:22Z"    }  ],  "work_orders": [    {      "id": "string",      "number": 0,      "organization_id": "string",      "project_id": "string",      "project": {        "key": "string"      },      "issue_id": "string",      "title": "string",      "description": "string",      "status": "string",      "priority": "urgent",      "due_date": "2019-08-24T14:15:22Z",      "work_type": "string",      "external_system": "string",      "external_id": "string",      "external_ref": "string",      "external_url": "string",      "payload": {        "property1": null,        "property2": null      },      "assigned_to": {        "id": "string",        "first_name": "string",        "last_name": "string",        "email": "string"      },      "devices": [        {          "device_id": "string",          "component": "string",          "status": "string",          "completed_at": "2019-08-24T14:15:22Z"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}