Sign in
Job

Find jobs based on search parameters.

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

jobIdsstring[] nullable

Filter to jobs whose ids are in the list

numbersinteger[] nullable

Filter jobs to only given numbers

jobNamesstring[] nullable

Filter jobs to only given names

status'draft' | 'needsReview' | 'approved' | 'engineering' | 'scheduled' | 'inProgress' | 'complete' | 'cancelled' | 'hold'

Job status

statusesJobStatusEnum[] nullable

Filter jobs to match the given statuses

parentItemIdstring nullable

Filter jobs based on the id of the parent item they produce

hasIncompleteOperationsboolean nullable

Filters jobs to have those that have at least 1 incomplete operation. Note that this will filter out jobs that haven't been approved yet because they technically have no operations on them until approved.

salesOrderIdstring nullable

Filters for jobs that are for this sales order id. Please reference /api/sales-orders endpoint.

createdBeforeUtcstring date-time nullable

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

createdAfterUtcstring date-time nullable

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

modifiedBeforeUtcstring date-time nullable

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

modifiedAfterUtcstring date-time nullable

Filters jobs 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 job.

productionDueDateFromstring date-time nullable

Filter to jobs whose production due date falls on or after this date. The whole day is included, so any time component is ignored.

productionDueDateTostring date-time nullable

Filter to jobs whose production due date falls on or before this date. The whole day is included, so a job due later that same day still matches.

completedOnFromstring date-time nullable

Filter to jobs 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 jobs completed on or before this date, as a whole day in the shop's timezone, so a job completed later that same shop day still matches.

Response

List of jobs 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.

parentItemIdstring required

Unique identifier of the parent item produced by this job. Please reference api/items endpoint.

quantityToMakenumber double required

Quantity of parent item produced by this job

productionDueDatestring date-time nullable

Due date

earliestStartDatestring date-time nullable

If set, this is the earliest date that the job should be scheduled to begin.

salesOrderIdstring nullable

Identifier of sales order fulfilled by this job, if applicable. Please reference api/sales-orders endpoint.

salesOrderLineItemIdstring nullable

Identifier of sales order line item fulfilled by this job, if applicable. Please reference endpoints nested under api/sales-orders.

createdUtcstring date-time

The date the job was created

originalScheduledStartUtcstring date-time nullable

The first scheduled start time.

originalScheduledEndUtcstring date-time nullable

The first scheduled end time.

scheduledStartUtcstring date-time nullable

The current scheduled start time.

scheduledEndUtcstring date-time nullable

The current scheduled end time.

completedOnUtcstring date-time nullable

The job completion datetime.

cancelledOnUtcstring date-time nullable

The job cancelled datetime.

revenuenumber double nullable

Revenue

notesstring nullable

Job level internal notes

workOrderIdsstring[] required

Identifier of work order(s) that this job is associated to, if applicable. Please reference api/work-orders endpoint.

status'draft' | 'needsReview' | 'approved' | 'engineering' | 'scheduled' | 'inProgress' | 'complete' | 'cancelled' | 'hold' required

Job status

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

Job priority

customFieldsobject nullable

Custom fields that have been defined on this entity.

Changes

Changed in 1 of the 23 revisions of this API.16

  • d743ab8b105f16See the full diff
    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property