Go to OI WebsiteRequest Access to Demo SiteContact Us

Schedule

get
Authorizations
Query parameters
rangecodestringRequired
plantcodestring · min: 1Optional
stationcodesstringOptional

Comma-separated list of Station Codes.

scheduleidsstringOptional

Comma-separated list of Schedule IDs.

Responses
200
200 OK
application/json
get
GET /api/schedule HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "id": 1,
      "stationCode": "text",
      "stationName": "text",
      "accountId": "text",
      "plannedStartAt": "text",
      "plannedStartAtTimestamp": 1,
      "plannedEndAt": "text",
      "plannedEndAtTimestamp": 1,
      "workOrderReference": "text",
      "plannedDuration": 1,
      "plannedQuantity": 1,
      "nonProductionReasonCode": "text",
      "nonProductionReasonDescription": "text",
      "skuCode": "text",
      "skuName": "text",
      "skuValue": 1,
      "batchSize": 1,
      "autoEndOnQuantityComplete": true,
      "cycleTime": 1,
      "unitsPerMinute": 1,
      "unitsPerHour": 1,
      "lineSpeedTarget": 1,
      "effectiveCycleTime": 1,
      "effectiveUnitsPerMinute": 1,
      "effectiveUnitsPerHour": 1,
      "effectiveLineSpeedTarget": 1,
      "effectiveBatchSize": 1,
      "effectiveMinimumCycleTime": 1,
      "deletedAt": "text",
      "actualStartAt": "text",
      "actualStartAtTimestamp": 1,
      "actualEndAt": "text",
      "actualEndAtTimestamp": 1,
      "quantityGood": 1,
      "quantityBad": 1,
      "skuGroupCode": "text",
      "skuGroupName": "text",
      "extendShift": true,
      "downtimeDurationThresholdMultiplier": 1,
      "isStarted": true,
      "isEnded": true,
      "allowScheduleCutShort": true,
      "idealQuantity": 1,
      "performanceIdeal": 1,
      "performanceActual": 1,
      "performanceModeFrom": "schedule",
      "logs": [
        "text"
      ],
      "priorityAt": "text"
    }
  ],
  "range": {
    "from": 1,
    "to": 1,
    "duration": 1,
    "fromIso": "text",
    "toIso": "text",
    "durationFormatted": "text"
  }
}
post
Authorizations
Body
idintegerOptional
stationCodestring · min: 1 · max: 32OptionalPattern: ^([a-zA-Z0-9-_]+)$
plannedStartAtany ofOptional
stringOptional
or
string · date-timeOptional
plannedEndAtany of | nullableOptional
stringOptional
or
string · date-timeOptional
plannedQuantitynumber | nullableOptional
skuCodestring | nullableOptionalPattern: ^([a-zA-Z0-9.\\/-]+)$
workOrderReferencestring | nullableOptional
nonProductionReasonCodestring | nullableOptional
calculatedQuantitynumberOptional
calculatedEndAtstring · date-timeOptional
predictedQuantitynumberOptional
predictedEndAtstring · date-timeOptional
lastPredictedAtstring · date-timeOptional
deletedAtstring · date-timeOptional
actualStartAtany of | nullableOptional
stringOptional
or
string · date-timeOptional
actualEndAtany of | nullableOptional
stringOptional
or
string · date-timeOptional
skuGroupCodestring | nullableOptionalPattern: ^([a-zA-Z0-9.\\/-]+)$
cycleTimeinteger | nullableOptional
extendShiftbooleanOptional
orderTypestring · enumOptionalPossible values:
unitsPerMinuteinteger | nullableOptional
unitsPerHourinteger | nullableOptional
lineSpeedTargetinteger | nullableOptional
batchSizenumber | nullableOptional
priorityAtstring | nullableOptional
autoEndOnQuantityCompleteboolean | nullableOptional
skuNamestringOptional
Responses
200
200 OK
application/json
post
POST /api/schedule HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 653

{
  "id": 1,
  "stationCode": "text",
  "plannedStartAt": "text",
  "plannedEndAt": "text",
  "plannedQuantity": 1,
  "skuCode": "text",
  "workOrderReference": "text",
  "nonProductionReasonCode": "text",
  "calculatedQuantity": 1,
  "calculatedEndAt": "2025-07-30T08:23:17.577Z",
  "predictedQuantity": 1,
  "predictedEndAt": "2025-07-30T08:23:17.577Z",
  "lastPredictedAt": "2025-07-30T08:23:17.577Z",
  "deletedAt": "2025-07-30T08:23:17.577Z",
  "actualStartAt": "text",
  "actualEndAt": "text",
  "skuGroupCode": "text",
  "cycleTime": 1,
  "extendShift": true,
  "orderType": "quantity",
  "unitsPerMinute": 1,
  "unitsPerHour": 1,
  "lineSpeedTarget": 1,
  "batchSize": 1,
  "priorityAt": "text",
  "autoEndOnQuantityComplete": true,
  "skuName": "text"
}
{
  "isSuccess": true,
  "result": {
    "id": 1,
    "stationCode": "text",
    "plannedStartAt": "text",
    "plannedEndAt": "text",
    "plannedQuantity": 1,
    "skuCode": "text",
    "nonProductionReasonCode": "text",
    "workOrderReference": "text",
    "calculatedQuantity": 1,
    "calculatedEndAt": "text",
    "predictedQuantity": 1,
    "predictedEndAt": "text",
    "lastPredictedAt": "text",
    "deletedAt": "text",
    "accountId": "text",
    "actualStartAt": "text",
    "actualEndAt": "text",
    "skuGroupCode": "text",
    "cycleTime": 1,
    "unitsPerMinute": 1,
    "unitsPerHour": 1,
    "lineSpeedTarget": 1,
    "batchSize": 1,
    "extendShift": true,
    "priorityAt": "text",
    "autoEndOnQuantityComplete": true,
    "createdAt": "text",
    "updatedAt": "text"
  }
}
get
Authorizations
Query parameters
stationcodesstringOptional

Comma-separated list of Station Codes.

plantcodestring · min: 1Optional
skucodesstringOptional

Comma-separated list of SKU Codes.

Responses
200
200 OK
application/json
get
GET /api/schedule/workorder HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "result": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "id": 1,
          "stationCode": "text",
          "stationName": "text",
          "accountId": "text",
          "plannedStartAt": "text",
          "plannedStartAtTimestamp": 1,
          "plannedEndAt": "text",
          "plannedEndAtTimestamp": 1,
          "workOrderReference": "text",
          "plannedDuration": 1,
          "plannedQuantity": 1,
          "nonProductionReasonCode": "text",
          "nonProductionReasonDescription": "text",
          "skuCode": "text",
          "skuName": "text",
          "skuValue": 1,
          "batchSize": 1,
          "autoEndOnQuantityComplete": true,
          "cycleTime": 1,
          "unitsPerMinute": 1,
          "unitsPerHour": 1,
          "lineSpeedTarget": 1,
          "effectiveCycleTime": 1,
          "effectiveUnitsPerMinute": 1,
          "effectiveUnitsPerHour": 1,
          "effectiveLineSpeedTarget": 1,
          "effectiveBatchSize": 1,
          "effectiveMinimumCycleTime": 1,
          "deletedAt": "text",
          "actualStartAt": "text",
          "actualStartAtTimestamp": 1,
          "actualEndAt": "text",
          "actualEndAtTimestamp": 1,
          "quantityGood": 1,
          "quantityBad": 1,
          "skuGroupCode": "text",
          "skuGroupName": "text",
          "extendShift": true,
          "downtimeDurationThresholdMultiplier": 1,
          "isStarted": true,
          "isEnded": true,
          "allowScheduleCutShort": true,
          "idealQuantity": 1,
          "performanceIdeal": 1,
          "performanceActual": 1,
          "performanceModeFrom": "schedule",
          "logs": [
            "text"
          ],
          "priorityAt": "text"
        }
      ]
    }
  }
}
post
Authorizations
Path parameters
idintegerRequired
Responses
200
200 OK
application/json
post
POST /api/schedule/{id}/cutshort HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true
}
delete
Authorizations
Path parameters
idintegerRequired
Responses
204
204 No Content
delete
DELETE /api/schedule/{id} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content
PreviousProductionNextShift