Schedule

get

Authorizations

X-API-KEYstringRequired

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

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

/schedule

GET /api/schedule?rangecode=text 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,
      "performanceModeFrom": "schedule",
      "logs": [
        "text"
      ],
      "priorityAt": "text"
    }
  ],
  "range": {
    "from": 1,
    "to": 1,
    "duration": 1,
    "fromIso": "text",
    "toIso": "text",
    "durationFormatted": "text"
  }
}

post

Authorizations

X-API-KEYstringRequired

Body

idintegerOptional

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

plannedStartAtany ofOptional

stringOptional

string · date-timeOptional

plannedEndAtany ofOptional

stringOptional

string · date-timeOptional

nullOptional

plannedQuantitynumber | nullOptional

skuCodestring | null · min: 1 · max: 32OptionalPattern: ^([a-zA-Z0-9.\\/-]+)$

workOrderReferencestring | nullOptional

nonProductionReasonCodestring | null · min: 1 · max: 50Optional

calculatedQuantitynumberOptional

calculatedEndAtstring · date-timeOptional

predictedQuantitynumberOptional

predictedEndAtstring · date-timeOptional

lastPredictedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

actualStartAtany ofOptional

stringOptional

string · date-timeOptional

nullOptional

actualEndAtany ofOptional

stringOptional

string · date-timeOptional

nullOptional

skuGroupCodestring | null · min: 1 · max: 32OptionalPattern: ^([a-zA-Z0-9.\\/-]+)$

cycleTimeinteger | null · max: 43200000Optional

extendShiftbooleanOptional

orderTypestring · enumOptionalPossible values:

unitsPerMinuteinteger | nullOptional

unitsPerHourinteger | nullOptional

lineSpeedTargetinteger | nullOptional

batchSizenumber | nullOptional

priorityAtstring | nullOptional

autoEndOnQuantityCompleteboolean | nullOptional

skuNamestringOptional

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

/schedule

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

{
  "id": 1,
  "stationCode": "text",
  "plannedStartAt": "text",
  "plannedEndAt": "text",
  "plannedQuantity": null,
  "skuCode": null,
  "workOrderReference": null,
  "nonProductionReasonCode": null,
  "calculatedQuantity": 1,
  "calculatedEndAt": "2026-01-02T05:12:45.009Z",
  "predictedQuantity": 1,
  "predictedEndAt": "2026-01-02T05:12:45.009Z",
  "lastPredictedAt": "2026-01-02T05:12:45.009Z",
  "deletedAt": "2026-01-02T05:12:45.009Z",
  "actualStartAt": "text",
  "actualEndAt": "text",
  "skuGroupCode": null,
  "cycleTime": null,
  "extendShift": true,
  "orderType": "quantity",
  "unitsPerMinute": null,
  "unitsPerHour": null,
  "lineSpeedTarget": null,
  "batchSize": null,
  "priorityAt": null,
  "autoEndOnQuantityComplete": null,
  "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

X-API-KEYstringRequired

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

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

/schedule/workorder

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,
          "performanceModeFrom": "schedule",
          "logs": [
            "text"
          ],
          "priorityAt": "text"
        }
      ]
    }
  }
}

post

Authorizations

X-API-KEYstringRequired

Path parameters

idintegerRequired

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

/schedule/{id}/cutshort

POST /api/schedule/{id}/cutshort HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true
}

delete

Authorizations

X-API-KEYstringRequired

Path parameters

idintegerRequired

Responses

204

204 No Content

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

delete

/schedule/{id}

DELETE /api/schedule/{id} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

PreviousReason NextShift

Last updated 4 months ago