Nesting

List nestable groups — each a material shape paired with the operation it is cut on, carrying the job operations still waiting to be nested and the work-order operations already created.

post/api/nesting/nestable-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

needNestingboolean nullable

When true, keeps only groups that still have job operations waiting to be nested.

existingNestsboolean nullable

When true, keeps only groups that already have a work-order operation.

materialFormsNestingEnumNestableMaterialFormEnum[] nullable

Keeps only groups whose material shape has one of these stock forms.

operationIdsstring[] nullable

Keeps only groups on one of these routing operations.

materialShapeIdsstring[] nullable

Keeps only groups on one of these material shapes.

earliestStartOnOrBeforestring date-time nullable

Keeps only groups whose earliest scheduled-start job operation falls on or before this calendar date. Only the calendar date is used, exactly as written; any time or UTC offset is ignored. A group with no dated job operation is dropped as well, which means existing-nest-only groups never survive this filter.

searchstring nullable

Single search token, matched case-insensitively as a substring against the job name and number, the customer name, the sales order number and name, the item name, the work order name, the material shape name, and the operation name. Not split on whitespace.

Response

The page of matching groups.

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes

Changed in 2 of the 23 revisions of this API.21

    • ▲

      the /// response property's maxLength was increased from 24 to 36 for the response status (media type: application/json)

      response-property-max-length-increased

    • ▲

      the /// response property's maxLength was increased from 24 to 36 for the response status (media type: application/problem+json)

      response-property-max-length-increased

    • ○

      endpoint added

      endpoint-added