Sign in
NCRs

Finds NCRs based on search parameters

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

statusstring nullable

Filter NCRs by a specific status Accepted Values: Closed, Hold, New, Quality Review, Engineering Review

typestring nullable

Filter NCRs by a specific type. Available values are configured per tenant in Quality settings (NCR dropdowns).

causestring nullable

Filter NCRs by a specific cause. Available values are configured per tenant in Quality settings (NCR dropdowns).

reasonstring nullable

Filter NCRs by a specific reason. Available values are configured per tenant in Quality settings (NCR dropdowns).

createdUtcstring date-time nullable

Filter NCRs created on or after this instant, time of day included. Combines with FulcrumProduct.PublicApi.Controllers.NCRs.Request.NcrListParameters.CreatedFrom when both are sent.

createdFromstring date-time nullable

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

createdTostring date-time nullable

Filter to NCRs created on or before this date, as a whole day in the shop's timezone, so an NCR created later that same shop day still matches.

Response

OK

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