Sign in
Tool

Finds tools based on search parameters, including calibration due-date windows and the derived calibration status.

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

searchstring nullable

Whitespace-insensitive search over tool name, serial number, and tool type

toolTypesToolType[] nullable

Only tools of these types

toolStatusesToolStatus[] nullable

Only tools with these statuses

calibrationStatusesToolCalibrationEnumCalibrationResult[] nullable

Only tools whose derived status matches one of these values. Every tool is judged on its active track: a scheduled tool on its latest calibration, a reference gage on its latest in-house verification (a gage with no verifications derives NotApplicable).

referenceboolean

Only reference gages (tools with calibration frequency None). AND-combined with FulcrumProduct.PublicApi.Dto.Tool.Request.ToolsListParameters.CalibrationStatuses and the other filters.

isOverdueboolean

Only tools whose next calibration is past due. Never matches an out-of-service tool — any inactive tool, unless its reason is OutForCalibration — because such a tool no longer needs calibration

dueWithin7Daysboolean

Only tools due for calibration within the next 7 days (includes overdue tools; never matches out-of-service tools — see FulcrumProduct.PublicApi.Dto.Tool.Request.ToolsListParameters.IsOverdue)

dueWithin30Daysboolean

Only tools due for calibration within the next 30 days (includes overdue tools; never matches out-of-service tools — see FulcrumProduct.PublicApi.Dto.Tool.Request.ToolsListParameters.IsOverdue)

requiresActionboolean

Only tools needing action: inactive with reason RequiresRepair

calibratedboolean

Only tools in good standing: active, not overdue, and passed their latest calibration

nextCalibrationDateFromstring date-time nullable

Only tools whose next calibration is due on or after this date, the whole day included. A tool with no due date never matches.

nextCalibrationDateTostring date-time nullable

Only tools whose next calibration is due on or before this date, the whole day included. A tool with no due date never matches.

modifiedAfterUtcstring date-time nullable

Only tools whose record was written strictly after this UTC instant. Poll with the last-seen modifiedUtc to pick up creates and edits; time-derived transitions (a tool becoming due or overdue) and deletions do not advance modifiedUtc — use the due-window filters for schedule tracking

Response

The matching tools

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 23 revisions of this API.8

  • d743ab8b105f8See 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