v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Work Order

Find work orders based on search parameters.

post/api/work-orders/list

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

workOrderIdsstring[] nullable

Filter to work orders whose ids are in the list

numbersinteger[] nullable

Filter to only given numbers

namesstring[] nullable

Filter to only given names

statusesWorkOrderStatusEnum[] nullable

Filter to match the given statuses

createdBeforeUtcstring date-time nullable

Filters jobs created before (exclusive) this parameter in UTC time. If not time component is passed, midnight UTC will be used.

createdAfterUtcstring date-time nullable

Filters jobs created after (exclusive) this parameter in UTC time. If not time component is passed, midnight UTC will be used.

List of work orders matching the filters

idstring required

Unique Id associated to this entity

numberinteger required

Job number

namestring required

Job name, defaults to number unless otherwise specified.

createdUtcstring date-time

The date the job was created

completedOnUtcstring date-time nullable

The job completion datetime.

cancelledOnUtcstring date-time nullable

The job cancelled datetime.

scheduledStartUtcstring date-time nullable

The current scheduled start time.

scheduledEndUtcstring date-time nullable

The current scheduled end time.

Work order status

priority'low' | 'moderate' | 'high'

Job priority