Sign in
Operation

Find operations based on search parameters.

post/api/operations/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

namestring nullable

Filter operations based on their name.

modifiedBeforeUtcstring date-time nullable

Filters operations modified before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

modifiedAfterUtcstring date-time nullable

Filters operations modified after (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used. Useful for polling incrementally instead of re-syncing every operation.

Response

List of operations matching the filters

idstring required

Unique id associated to this entity.

namestring required

Identifying name. Must be unique.

descriptionstring nullable

A verbose description of the location.

machineTimeTrackingEnabledboolean nullable

Is machine time tracking enabled.

isOutsideProcessingboolean

Specifies whether this is an outside processing operation

unattendedboolean

Specifies whether this is operation will be unattended.

defaultVendorIdstring nullable

Default vendor id that will be used for this operation. Please reference /api/vendors endpoint.

leadDaysinteger

Lead days.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

isNestableboolean

Indicates if this operation is nestable.

instructionsstring nullable

Instructions.

Changes