Sign in
Reporting

Lists report-ready material and item requirement rows for scheduled job operations from the material-requirements reporting view, with resolved required quantities, so callers do not need to fan out per job to routings, items-to-make, operations, and per-operation requirement lookups.

post/api/reporting/material-requirements/list

Query parameters

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)

Request body

jobStatusstring nullable

Optional exact-match filter on the job lifecycle status (e.g. "Scheduled", "In Progress"). Null means no job-status filter.

operationNamestring nullable

Optional exact-match filter on the operation name (e.g. "Turret Laser"). Null means no operation-name filter.

operationStatusstring nullable

Optional exact-match filter on the operation lifecycle status (e.g. "Ready", "Running"). Null means no operation-status filter.

requirementTypestring nullable

Optional exact-match filter on the requirement type: "Item" or "Material". Null returns both.

productionDueDateFromstring date-time nullable

Inclusive lower bound applied to the job's Production Due Date. Null means no lower bound.

productionDueDateTostring date-time nullable

Inclusive upper bound applied to the job's Production Due Date (the whole to day is included). Null means no upper bound.

Response

A page of material-requirements report rows with the total matching count.

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 1 of the 12 revisions of this API.6

  • 016c1fd45a3f6See the full diff
    • ○

      added the optional property data/items/collectedQuantityLbs to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property data/items/collectedQuantityLbs to the response with the 200 status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property data/items/outstandingQuantityLbs to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property data/items/outstandingQuantityLbs to the response with the 200 status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property data/items/requiredQuantityLbs to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property data/items/requiredQuantityLbs to the response with the 200 status (media type: application/problem+json)

      response-optional-property-added