Equipment Downtime

Find equipment downtimes based on search parameters. Deleted downtimes are not returned. Sort by `id`, `startDateTime`, `endDateTime` or `createdUtc`, ignoring case. Downtimes that tie on the sort field are ordered by `id` ascending. Without a sort field, results are ordered by creation date, newest first, whatever the sort direction.

Changed on
post/api/equipment-downtimes/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/equipment-downtimes/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 downtimes to those with one of these ids.

departmentIdsstring[] nullable

Filter downtimes to those covering at least one of these departments.

startsBeforeUtcstring date-time nullable

Filter downtimes that start before (exclusive) this time in UTC. If no time component is passed, midnight UTC will be used.

endsAfterUtcstring date-time nullable

Filter downtimes that end after (exclusive) this time in UTC. If no time component is passed, midnight UTC will be used. Combine with startsBeforeUtc to find downtimes overlapping a window.

Response

List of equipment downtimes matching the filters

idstring

Unique id of the downtime.

startDateTimestring date-time

When the downtime starts, in UTC.

endDateTimestring date-time

When the downtime ends, in UTC.

deletedboolean

Indicates whether this downtime has been deleted.

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)

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

    • info

      endpoint added