List Work Order Templates

GET

https://api.coperniq.io/v1/work-orders/templates

GET

/v1/work-orders/templates

1 const url = 'https://api.coperniq.io/v1/work-orders/templates';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 [
2   {
3     "id": 1,
4     "createdAt": "2024-01-15T09:30:00Z",
5     "updatedAt": "2024-01-15T09:30:00Z",
6     "title": "string",
7     "description": "string",
8     "instructions": "string",
9     "type": "string",
10     "priority": 1,
11     "dueDate": "string",
12     "yellowSla": 1,
13     "redSla": 1,
14     "assignee": {
15       "id": 1,
16       "firstName": "string",
17       "lastName": "string"
18     },
19     "assigneeProperty": "string",
20     "collaborators": [
21       {
22         "id": 1,
23         "firstName": "string",
24         "lastName": "string"
25       }
26     ],
27     "collaboratorProperties": [
28       "string"
29     ],
30     "labels": [
31       {
32         "label": {
33           "id": 1,
34           "label": "string",
35           "color": "string"
36         }
37       }
38     ],
39     "checklists": [
40       {
41         "id": 1,
42         "detail": "string"
43       }
44     ],
45     "lineItems": [
46       {
47         "id": 1,
48         "quantity": 1.1,
49         "description": "string",
50         "unitCost": 1.1,
51         "totalCost": 1.1,
52         "unitPrice": 1.1,
53         "totalPrice": 1.1,
54         "catalogItem": {
55           "id": 1,
56           "name": "string",
57           "catalog": "ENERGY",
58           "type": "PRODUCT",
59           "category": "BATTERY_SYSTEM",
60           "cost": 1.1,
61           "price": 1.1,
62           "manufacturer": "string",
63           "sku": "string",
64           "code": "string",
65           "description": "string",
66           "image": {
67             "id": 1,
68             "name": "string",
69             "url": "string"
70           },
71           "isArchived": true,
72           "createdById": 1,
73           "createdAt": "2024-01-15T09:30:00Z",
74           "updatedAt": "2024-01-15T09:30:00Z",
75           "preferredVendorId": 1
76         }
77       }
78     ]
79   }
80 ]

Retrieve available work order templates. Returns all templates (not paginated).

Authentication

x-api-keystring

API Key authentication via header

Response

List of work order templates

idintegerOptional

Template identifier

createdAtstring or nullOptionalformat: "date-time"

updatedAtstring or nullOptionalformat: "date-time"

titlestring or nullOptional

Template title

descriptionstring or nullOptional

Template description

instructionsstring or nullOptional

Template instructions (same text as description)

typestring or nullOptional

Work order type (e.g. FIELD, OFFICE)

priorityinteger or nullOptional

dueDatestring or nullOptional

Deadline for work orders created from this template

yellowSlainteger or nullOptional

Yellow SLA threshold (days)

redSlainteger or nullOptional

Red SLA threshold (days)

assigneeobject or nullOptional

A user reference reduced to non-sensitive identity fields.

assigneePropertystring or nullOptional

Set when the assignee is a role rather than a specific user (e.g. SALES_REP, PROJECT_MANAGER).

collaboratorslist of objectsOptional

collaboratorPropertieslist of stringsOptional

Role-based collaborators (e.g. SALES_REP, PROJECT_MANAGER) as property keys.

labelslist of objectsOptional

checklistslist of objectsOptional

lineItemslist of objectsOptional

Present only when the template has line items.

Errors

401

Unauthorized Error