Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Root Cause Analysis Reports

List root cause analysis reports

Endpoint used to list root cause analysis report resources

get/rootcauseanalysisreports

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Root Cause Analysis Reports returned

assetsinteger[]

To filter by multiple asset IDs: assets=630&assets=634

statusesstring[]

To filter by multiple statuses: statuses=DRAFT&statuses=DONE

creatorsinteger[]

To filter by multiple creator IDs: creators=23494&creators=79808

archivedboolean

When true, return only archived reports. Defaults to false.

createdAfterstring date-time

Return reports whose createdAt is at or after this ISO 8601 date-time (UTC).

createdBeforestring date-time

Return reports whose createdAt is at or before this ISO 8601 date-time (UTC).

expandstring[]

To expand multiple fields: expand=main_asset&expand=main_asset_status

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Root Cause Analysis Reports list

nextCursorstring nullable required

The cursor to retrieve the next page of Root Cause Analysis Reports.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Root Cause Analysis Reports.

Example response

{
  "rootCauseAnalysisReports": [
    {
      "id": 4242,
      "organizationId": 1,
      "mainAssetId": 963,
      "mainAssetStatusId": 8123,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "completedAt": "2022-01-01T00:00:00.000Z",
      "incidentStartedAt": "2022-01-01T00:00:00.000Z",
      "incidentEndedAt": "2022-01-01T00:00:00.000Z",
      "incidentDuration": 86400,
      "repairTime": 7200,
      "notes": {
        "text": "Loose coupling caused the conveyor to skip."
      },
      "creatorId": 23494,
      "updaterId": 23494,
      "archivedAt": "2022-01-01T00:00:00.000Z",
      "mainAsset": {
        "id": 963,
        "name": "Forklift",
        "description": "Forklift that is used to to move heavy equipments around the warehouse",
        "parentId": 852,
        "criticalityId": 150,
        "locationId": 852,
        "serialNumber": "000123ABC",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z",
        "creatorId": 851
      },
      "mainAssetStatus": {
        "id": 42,
        "customStatus": {
          "label": "Decommissioned",
          "createdAt": "2022-01-01T12:34:56.123Z",
          "updatedAt": "2022-01-01T12:34:56.123Z",
          "deletedAt": "2022-01-01T12:34:56.123Z"
        },
        "customStatusId": 53,
        "status": "OFFLINE",
        "downtimeType": "PLANNED",
        "startedAt": "2022-01-01T12:34:56.123Z",
        "endedAt": "2022-01-01T12:34:56.123Z",
        "description": "Overheated - needs servicing.",
        "createdAt": "2022-01-01T12:34:56.123Z",
        "updatedAt": "2022-01-01T12:34:56.123Z",
        "deletedAt": "2022-01-01T12:34:56.123Z"
      },
      "problems": [
        {
          "id": 7311,
          "category": {
            "id": 902,
            "label": "Mechanical Failure"
          },
          "stepOptions": [
            {
              "id": 5018,
              "label": "Worn bearings"
            }
          ],
          "notes": {
            "text": "Loose coupling caused the conveyor to skip."
          }
        }
      ]
    }
  ]
}