Create Project Work Order

POST

https://api.coperniq.io/v1/projects/:project_id/work-orders

Create a new work order in a project.

Notes:

templateId is required.
phaseInstanceId is optional; if provided the referenced phase must be started (active) for creation to succeed.

Create a new work order in a project. Notes: - `templateId` is required. - `phaseInstanceId` is optional; if provided the referenced phase must be started (active) for creation to succeed.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

project_idintegerRequired

Project identifier

Request

This endpoint expects an object.

templateIdintegerRequired

Template to use for the work order

phaseInstanceIdintegerOptional

Optional. Phase instance id where the work order will be created (phase must be started). You can gather phase instance ids from the get project endpoint.

Response

Work order created successfully

idintegerOptional

Created workflow element (task) identifier

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

descriptionstring or nullOptional

positionintegerOptional

Position within phase

phaseInstanceIdintegerOptional

projectIdintegerOptional

createdByIdintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/projects/1/work-orders';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"templateId":1}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

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	}