FUfulcrumpro
Equipment

Find equipment based on search parameters.

Changed on
post/api/equipment/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/equipment/list
  • Auth
    none declared

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

idsstring[] nullable

Filter equipment based on matching ids.

namestring nullable

Filter equipment based on their name.

includeDeletedboolean

When true, deleted equipment are returned alongside live ones, with deleted set to true and deletedUtc stamped. Defaults to false, in which case only live equipment are returned.

Response

List of equipment matching the filters

idstring required

Unique id associated to this entity.

namestring required

Identifying name. Must be unique.

descriptionstring nullable

Description.

workCenterIdstring nullable

WorkCenter identifier. Please reference /api/work-centers endpoint.

manufacturerstring nullable

Manufacturer.

modelNumberstring nullable

Model number.

serialNumberstring nullable

Serial number.

canRunUnattendedboolean nullable

Indicates if this equipment can be run unattended. This allows the portion of an operation that utilizes this equipment to be scheduled outside of a shift.

unlimitedCapacityboolean nullable

Indicates if this equipment can support multiple operations simultaneously.

status'good' | 'poor' | 'bad' | 'outOfService'

Equipment status

notesstring nullable

Notes associated to the equipment.

deletedboolean

Indicates whether this equipment has been deleted

deletedUtcstring date-time nullable

When this equipment was deleted (UTC), or null while it is live.

Changes

  • 92b1fb690ceeRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • c3bdc499d639Revision changes
    • breaking

      the request property's minItems was increased to 1 (media type: application/json-patch+json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/json)

    • breaking

      the request property's minItems was increased to 1 (media type: text/json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/*+json)