Create a new WorkOrder

Creates a new Work Order with the provided properties and returns its ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The Work Order's subject

string

A detailed description of the Work Order

string

The reference of the Work Order status.

string

The reference of the Work Order type.

string
enum
Defaults to 000_low

The priority of the Work Order.

Allowed:
string

The due date of the Work Order.

string

The external reference (ERP Reference) of the Work Order.

string

The parent Work Order external reference (ERP Reference) of the Work Order. (Provide either this or the parentWorkOrderId)

string

The parent Work Order internal ID of the Work Order. (Provide either this or the parentWorkOrderExternalReference)

string

The related organization internal ID of the Work Order.

relatedAssetIds
array of strings

The related asset internal IDs of the Work Order.

relatedAssetIds
customPropertyValues
array of objects

The custom property values of the Work Order.

customPropertyValues
string

The start date of the work order. Must be provided together with endDate.

string

The end date of the work order. Must be provided together with startDate. Must be after startDate.

boolean

Whether the work order is planned for the full day. This field is ignored if startDate and endDate are not provided. When true, startDate will be set to the beginning of the day and endDate to the end of the day in the specified timezone.

string
enum

The time zone for the planned work order. This field is ignored if startDate and endDate are not provided. If not provided, the tenant timezone will be used.

assignedContactIds
array of strings

The performing contact internal IDs for the work order planning.

assignedContactIds
assignedGroupIds
array of strings

The performing group internal IDs for the work order planning.

assignedGroupIds
string

The responsible group internal ID for the work order.

string

The responsible contact internal ID for the work order.

number

The estimated duration in seconds for the work order.

Responses

400

Bad Request

403

Forbidden

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json