DUET PlatformDocs
API referenceRead APIIssues and work orders

Get a work order

planned

Planned

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

Returns one work order, in the same shape as in the workorder.* 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 work order.

application/json
  1. response

A work order, as it was when the change happened.

id*string
number*integer
organization_id*string
project_id*string
project*
issue_id*|

The ID of the DUET issue that the work order belongs to. Null when the work order has no issue.

title*string
description*string|null
status*string

The work-order status, stored as your system sent it. An open set of values. complete and cancelled are terminal.

priority*|

The priority. Null when no priority is set.

Value in"urgent""high""medium""low"
due_date*|
Formatdate-time
work_type*string|null
external_system*|

The integration that owns the work order. Null while the work order exists only in DUET.

external_id*|

The work order's primary key in your system.

external_ref*|

The work-order number that operators see and quote.

external_url*string|null
payload*

Additional fields that your sync call sent. DUET stores them unchanged.

assigned_to*|

A DUET user.

created_by*|

The user who created the work order. Null when an inbound sync call created it.

devices*array<>
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
issue*|null
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/work-orders/string?project_id=string'
Example Response
{  "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"  },  "created_by": {    "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",  "issue": {    "id": "string",    "number": 0,    "name": "string",    "status": "string",    "project_id": "string",    "project": {      "key": "string"    }  }}

List loss events GET

Get an issue GETPlanned

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