latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Asset Statuses

List asset statuses

Endpoint used to list assetStatuses resources

get/assetstatuses

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Asset Statuses returned

assetIdinteger[]

To filter by multiple assetId IDs: assetIds=630

Attribute on which to sort the list. (for descending order, prefix attribute with '-'). The default sorting key is : created_at and direction descending

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Asset Statuses list

nextCursorstring nullable required

The cursor to retrieve the next page of Asset Statuses.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Asset Statuses.

Example response

{
  "assetStatuses": [
    {
      "id": 42,
      "customStatusId": 53,
      "assetId": 51,
      "status": "OFFLINE",
      "downtimeType": "PLANNED",
      "startedAt": "2022-01-01T12:34:56.123Z",
      "endedAt": "2022-01-01T12:34:56.123Z",
      "organizationId": 51,
      "creatorId": 51,
      "updaterId": 51,
      "createdAt": "2022-01-01T12:34:56.123Z",
      "updatedAt": "2022-01-01T12:34:56.123Z",
      "deletedAt": "2022-01-01T12:34:56.123Z",
      "description": "Overheated - needs servicing."
    }
  ]
}