Sign in
Work Order

Find work orders based on search parameters.

post/api/work-orders/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

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.

completedOnFromstring date-time nullable

Filter to work orders completed on or after this date, as a whole day in the shop's timezone. Any time component is ignored.

completedOnTostring date-time nullable

Filter to work orders completed on or before this date, as a whole day in the shop's timezone, so a work order completed later that same shop day still matches.

Response

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.

status'needsReview' | 'approved' | 'scheduled' | 'inProgress' | 'complete' | 'cancelled' required

Work order status

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

Job priority

Changes