Station

get

Authorizations

Query parameters

plantcodestring · min: 1Optional

stationcodesstringOptional

Comma-separated list of Station Codes.

sortbystring · min: 1Optional

modulevisibilityfilterstring · enumOptionalPossible values:

skipcachestring · min: 1Optional

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

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

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "name": "text",
      "groupCode": "text",
      "groupName": "text",
      "allowScheduleStationFlexibility": true,
      "plantCode": "text",
      "timezone": "text",
      "accountId": "text",
      "currentOperatorInitials": "text",
      "cycleTime": 1,
      "unitsPerMinute": 1,
      "unitsPerHour": 1,
      "lineSpeedTarget": 1,
      "allowInterruptionMode": true,
      "allowManualProduction": true,
      "downtimeDetectionMode": "off",
      "utilisationDowntimeThreshold": 1,
      "slowDurationThreshold": 1,
      "electricalUsageStoppedThresholdKw": 1,
      "allowScheduleCutShort": true,
      "productiveStatusMode": "productive_signal",
      "lineSpeedStoppedThreshold": 1,
      "shiftPatternId": 1,
      "productiveHoldOnTime": 1,
      "minimumCycleTime": 1,
      "statusCode": "text",
      "statusCodeUpdatedAt": "text",
      "shifts": [
        {
          "id": 1,
          "name": "text",
          "startHour": 1,
          "duration": 1,
          "accountId": "text",
          "shiftPatternId": 1,
          "weekDay": "text"
        }
      ],
      "currentShift": {
        "id": 1,
        "name": "text",
        "startHour": 1,
        "duration": 1,
        "accountId": "text",
        "shiftPatternId": 1,
        "weekDay": "text"
      },
      "currentProductionSchedule": {
        "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",
        "unitsPerMinute": 1,
        "unitsPerHour": 1,
        "lineSpeedTarget": 1,
        "batchSize": 1,
        "extendShift": true,
        "priorityAt": "text",
        "autoEndOnQuantityComplete": true,
        "createdAt": "text",
        "updatedAt": "text",
        "quantityGood": 1,
        "quantityBad": 1,
        "effectiveCycleTime": 1,
        "effectiveLineSpeedTarget": 1,
        "effectiveBatchSize": 1,
        "skuName": "text",
        "skuGroupName": "text"
      },
      "nextProductionSchedule": {
        "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",
        "unitsPerMinute": 1,
        "unitsPerHour": 1,
        "lineSpeedTarget": 1,
        "batchSize": 1,
        "extendShift": true,
        "priorityAt": "text",
        "autoEndOnQuantityComplete": true,
        "createdAt": "text",
        "updatedAt": "text",
        "quantityGood": 1,
        "quantityBad": 1,
        "effectiveCycleTime": 1,
        "effectiveLineSpeedTarget": 1,
        "effectiveBatchSize": 1,
        "skuName": "text",
        "skuGroupName": "text"
      },
      "currentNonProductionSchedule": {
        "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",
        "unitsPerMinute": 1,
        "unitsPerHour": 1,
        "lineSpeedTarget": 1,
        "batchSize": 1,
        "extendShift": true,
        "priorityAt": "text",
        "autoEndOnQuantityComplete": true,
        "createdAt": "text",
        "updatedAt": "text",
        "nonProductionReasonDescription": "text"
      },
      "currentStopReasonCode": "text",
      "stoppedSince": 1,
      "state": {
        "code": "text",
        "label": "text",
        "order": 1,
        "color": "text"
      },
      "idleCostPerMinute": 1,
      "moduleVisibility": [
        "utilisation"
      ],
      "cachedAt": 1,
      "allowQuickScheduleStart": true,
      "speedScale": 1,
      "speedOffset": 1,
      "speedToProductionRatio": 1,
      "forceAllShiftTimeAsPlannedProduction": true,
      "lastStationWindow": {
        "accountId": "text",
        "stationCode": "text",
        "windowStartAt": "text",
        "windowEndAt": "text",
        "totalMs": 1,
        "shiftMs": 1,
        "scheduledProductionMs": 1,
        "scheduledNonProductionMs": 1,
        "productiveMs": 1,
        "downtimeId": 1,
        "downtimeMs": 1,
        "downtimeReasonCode": "text",
        "downtimeSince": "text",
        "rssiAvg": 1,
        "productionGoodCount": 1,
        "productionBadCount": 1,
        "productionIdealCount": 1,
        "productionTargetCount": 1,
        "speed": 1,
        "errorCode": "text",
        "scheduleId": 1,
        "skuCode": "text",
        "isAlive": true,
        "electricalVoltsAvg": 1,
        "electricalAmpsAvg": 1,
        "electricalHzAvg": 1,
        "electricalPfAvg": 1,
        "electricalKwAvg": 1,
        "electricalKwh": 1,
        "statusCode": "text",
        "nonProductionReasonCode": "text",
        "skuGroupCode": "text",
        "electricalCost": 1,
        "costCurrency": "text",
        "electricalCo2": 1,
        "workOrderReference": "text",
        "lostProductionCostNonProduction": 1,
        "lostProductionCostDowntime": 1,
        "lostProductionCostSpeed": 1,
        "lostProductionCostQuality": 1,
        "performanceIdeal": 1,
        "performanceActual": 1,
        "performanceModeFrom": "text",
        "performanceModeType": "text",
        "productionGoodValue": 1,
        "productionBadValue": 1,
        "createdAt": "text",
        "updatedAt": "text"
      }
    }
  ]
}

post

Authorizations

Body

accountIdstringOptional

codestringRequired

namestring · min: 1 · max: 32Required

groupCodestringRequired

shiftPatternIdinteger | nullableOptional

minimumCycleTimeinteger | nullableOptional

speedScalenumber | nullableOptional

speedOffsetnumber | nullableOptional

speedToProductionRationumber | nullableOptional

idleCostPerMinutenumber | nullableOptional

downtimeDetectionModestring · enumOptionalDefault: utilisationPossible values:

utilisationDowntimeThresholdintegerOptional

slowDurationThresholdinteger | nullableOptional

forceAllShiftTimeAsPlannedProductionbooleanOptionalDefault: true

productiveStatusModestring · enumOptionalDefault: productive_signalPossible values:

electricalUsageStoppedThresholdKwnumber | nullableOptional

lineSpeedStoppedThresholdnumber | nullableOptional

productiveHoldOnTimeinteger | nullableOptional

allowInterruptionModebooleanOptionalDefault: false

allowManualProductionbooleanOptionalDefault: false

allowQuickScheduleStartbooleanOptionalDefault: false

allowScheduleCutShortbooleanOptionalDefault: false

currentOperatorInitialsstring | nullableOptional

statusCodestring | nullableOptional

statusCodeUpdatedAtstring | nullableOptional

cycleTimeinteger | nullableOptional

unitsPerMinuteinteger | nullableOptional

unitsPerHourinteger | nullableOptional

lineSpeedTargetnumber | nullableOptional

createdAtstring | nullableOptional

updatedAtstring | nullableOptional

archivedAtstring | nullableOptional

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

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

{
  "accountId": "text",
  "code": "text",
  "name": "text",
  "groupCode": "text",
  "shiftPatternId": 1,
  "moduleVisibility": [
    "utilisation"
  ],
  "minimumCycleTime": 1,
  "speedScale": 1,
  "speedOffset": 1,
  "speedToProductionRatio": 1,
  "idleCostPerMinute": 1,
  "downtimeDetectionMode": "utilisation",
  "utilisationDowntimeThreshold": 1,
  "slowDurationThreshold": 1,
  "forceAllShiftTimeAsPlannedProduction": true,
  "productiveStatusMode": "productive_signal",
  "electricalUsageStoppedThresholdKw": 1,
  "lineSpeedStoppedThreshold": 1,
  "productiveHoldOnTime": 1,
  "allowInterruptionMode": false,
  "allowManualProduction": false,
  "allowQuickScheduleStart": false,
  "allowScheduleCutShort": false,
  "currentOperatorInitials": "text",
  "statusCode": "text",
  "statusCodeUpdatedAt": "text",
  "cycleTime": 1,
  "unitsPerMinute": 1,
  "unitsPerHour": 1,
  "lineSpeedTarget": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "archivedAt": "text"
}

{
  "isSuccess": true,
  "results": [
    {
      "accountId": "text",
      "code": "text",
      "name": "text",
      "groupCode": "text",
      "shiftPatternId": 1,
      "moduleVisibility": [
        "utilisation"
      ],
      "minimumCycleTime": 1,
      "speedScale": 1,
      "speedOffset": 1,
      "speedToProductionRatio": 1,
      "idleCostPerMinute": 1,
      "downtimeDetectionMode": "utilisation",
      "utilisationDowntimeThreshold": 1,
      "slowDurationThreshold": 1,
      "forceAllShiftTimeAsPlannedProduction": true,
      "productiveStatusMode": "productive_signal",
      "electricalUsageStoppedThresholdKw": 1,
      "lineSpeedStoppedThreshold": 1,
      "productiveHoldOnTime": 1,
      "allowInterruptionMode": false,
      "allowManualProduction": false,
      "allowQuickScheduleStart": false,
      "allowScheduleCutShort": false,
      "currentOperatorInitials": "text",
      "statusCode": "text",
      "statusCodeUpdatedAt": "text",
      "cycleTime": 1,
      "unitsPerMinute": 1,
      "unitsPerHour": 1,
      "lineSpeedTarget": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "archivedAt": "text"
    }
  ]
}

delete

Authorizations

Path parameters

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

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

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

No content

PreviousSKU Group NextStation Group