Create Request Work Order | Coperniq

Create a new work order for a request.

Notes:

templateId is required.
phaseInstanceId is optional. The phase does not need to be started to create a request work order.

Create a new work order for a request. Notes: - `templateId` is required. - `phaseInstanceId` is optional. The phase does not need to be started to create a request work order.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

requestIdstringRequired

Request identifier

Request

This endpoint expects an object.

templateIdintegerRequired

The ID of the work order template to use

phaseInstanceIdintegerOptional

Optional. The ID of the phase instance to use. If provided, the phase does not need to be started to create a request work order. You can gather phase instance ids from the get request endpoint.

Response

Work order created successfully

idinteger or null

Created workflow element (task) identifier

createdAtstring or nullformat: "date-time"

updatedAtstring or nullformat: "date-time"

descriptionstring or null

positioninteger or null

Position within phase

phaseInstanceIdinteger or null

projectIdinteger or null

createdByIdinteger or null

1	import requests
2
3	url = "https://api.coperniq.io/v1/requests/requestId/work-orders"
4
5	payload = { "templateId": 1 }
6	headers = {
7	"x-api-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": 1,
3	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"description": "string",
6	"position": 1,
7	"phaseInstanceId": 1,
8	"projectId": 1,
9	"createdById": 1
10	}

Authentication

Path parameters

Request

Response

Errors