Downtime

get

Authorizations

Query parameters

stationcodesstringOptional

Comma-separated list of Station Codes.

rangecodestringOptional

plantcodestring · min: 1Optional

idintegerOptional

limitinteger · max: 1000Optional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/issue HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "id": 1,
      "type": "stop",
      "stationCode": "text",
      "startAt": "text",
      "endAt": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "startNotifiedAt": "text",
      "endNotifiedAt": "text",
      "accountId": "text",
      "excludedAt": "text",
      "events": [
        {
          "id": 1,
          "downtimeId": 1,
          "type": "acknowledge",
          "userId": 1,
          "estimateEndAt": "text",
          "notifiedAt": "text",
          "causeCode": "text",
          "accountId": "text",
          "createdAt": "text",
          "updatedAt": "text",
          "operatorInitials": "text",
          "userEmail": "text"
        }
      ],
      "isAcknowledged": true,
      "isEstimated": true,
      "isEscalated": true,
      "hasCause": true,
      "causeCode": "text",
      "estimateEndAt": "text",
      "ragStatus": "#cc3311",
      "statusText": "text",
      "stationName": "text",
      "causeBreadcrumb": [
        {
          "code": "text",
          "description": "text",
          "parentReasonCode": "text",
          "type": [
            "downtime"
          ]
        }
      ],
      "startAtTimestamp": 1,
      "endAtTimestamp": 1,
      "duration": 1,
      "durationFormatted": "text",
      "skuCode": "text",
      "skuName": "text",
      "isOngoing": true
    }
  ]
}

post

Authorizations

Body

typestring · enumRequiredPossible values:

stationCodestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9-_]+)$

startAtstring · date-timeRequired

endAtstring · date-timeOptional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

HTTPcURLJavaScriptPython

POST /api/issue HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "type": "stop",
  "stationCode": "text",
  "startAt": "2025-07-30T08:21:48.314Z",
  "endAt": "2025-07-30T08:21:48.314Z"
}

{
  "isSuccess": true,
  "results": [
    {
      "id": 1,
      "type": "stop",
      "stationCode": "text",
      "startAt": "text",
      "endAt": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "startNotifiedAt": "text",
      "endNotifiedAt": "text",
      "accountId": "text",
      "excludedAt": "text"
    }
  ]
}

get

Authorizations

Query parameters

stationcodesstringRequired

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/downtime/ongoing HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "id": 1,
      "type": "stop",
      "stationCode": "text",
      "startAt": "text",
      "endAt": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "startNotifiedAt": "text",
      "endNotifiedAt": "text",
      "accountId": "text",
      "excludedAt": "text",
      "events": [
        {
          "id": 1,
          "downtimeId": 1,
          "type": "acknowledge",
          "userId": 1,
          "estimateEndAt": "text",
          "notifiedAt": "text",
          "causeCode": "text",
          "accountId": "text",
          "createdAt": "text",
          "updatedAt": "text",
          "operatorInitials": "text",
          "userEmail": "text"
        }
      ],
      "isAcknowledged": true,
      "isEstimated": true,
      "isEscalated": true,
      "hasCause": true,
      "causeCode": "text",
      "estimateEndAt": "text",
      "ragStatus": "#cc3311",
      "statusText": "text",
      "stationName": "text",
      "causeBreadcrumb": [
        {
          "code": "text",
          "description": "text",
          "parentReasonCode": "text",
          "type": [
            "downtime"
          ]
        }
      ],
      "startAtTimestamp": 1,
      "endAtTimestamp": 1,
      "duration": 1,
      "durationFormatted": "text",
      "skuCode": "text",
      "skuName": "text",
      "isOngoing": true
    }
  ]
}

get

Authorizations

Query parameters

stationcodesstringRequired

rangecodestringRequired

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/downtime/unreported-downtime/count HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "stationCode": "text",
      "count": 1
    }
  ]
}

post

Authorizations

Path parameters

idintegerRequired

Body

typestring · enumRequiredPossible values:

estimatedTimenumberOptional

causeCodestring · min: 1Optional

operatorstringOptional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

HTTPcURLJavaScriptPython

POST /api/downtime/{id}/event HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "type": "acknowledge",
  "estimatedTime": 1,
  "causeCode": "text",
  "operator": "text"
}

{
  "isSuccess": true
}

get

Authorizations

Query parameters

plantcodestring · min: 1Required

rangecodestringRequired

aggregatewindowstringOptional

stationcodesstringOptional

Comma-separated list of Station Codes.

skucodesstringOptional

Comma-separated list of SKU Codes.

includefuturestring · min: 1Optional

inshiftaveragesbooleanOptional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/downtime HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "stationCode": "text",
      "stationName": "text",
      "stationGroupCode": "text",
      "stationGroupName": "text",
      "reliabilityData": {
        "runningsCount": 1,
        "stopsCount": 1,
        "totalRunningTime": 1,
        "totalStoppedTime": 1
      },
      "cycleTimeAnalysis": {
        "avg": 1,
        "min": 1,
        "max": 1,
        "quantity": 1,
        "default": 1,
        "stations": [
          {
            "stationCode": "text",
            "stationName": "text",
            "avg": 1,
            "min": 1,
            "max": 1,
            "quantity": 1
          }
        ]
      },
      "oee": {
        "scheduleMs": 1,
        "scheduleLossMs": 1,
        "schedulePerc": 1,
        "productionScheduleMs": 1,
        "productionScheduleLossMs": 1,
        "productionSchedulePerc": 1,
        "availabilityMs": 1,
        "availabilityLossMs": 1,
        "availabilityPerc": 1,
        "performanceMs": 1,
        "performanceLossMs": 1,
        "performancePerc": 1,
        "goodQualityCount": 1,
        "goodQualityLossCount": 1,
        "goodQualityPerc": 1,
        "scheduledNonProduction": [
          {
            "code": "text",
            "description": "text",
            "duration": 1,
            "cost": 1,
            "percent": 1
          }
        ],
        "stops": [
          {
            "code": "text",
            "description": "text",
            "duration": 1,
            "cost": 1,
            "percent": 1
          }
        ],
        "oee": 1
      },
      "downtimes": [
        {
          "type": "stop",
          "stationCode": "text",
          "reasonCode": "text",
          "startTimestamp": 1,
          "endTimestamp": 1,
          "range": {
            "from": 1,
            "to": 1,
            "duration": 1,
            "fromIso": "text",
            "toIso": "text",
            "durationFormatted": "text"
          }
        }
      ]
    }
  ],
  "range": {
    "from": 1,
    "to": 1,
    "duration": 1,
    "fromIso": "text",
    "toIso": "text",
    "durationFormatted": "text"
  }
}