Station

get

Authorizations

X-API-KEYstringRequired

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

/station

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": null,
      "groupName": null,
      "allowScheduleStationFlexibility": null,
      "plantCode": "text",
      "timezone": "text",
      "accountId": "text",
      "currentOperatorInitials": null,
      "cycleTime": null,
      "unitsPerMinute": null,
      "unitsPerHour": null,
      "lineSpeedTarget": null,
      "allowInterruptionMode": null,
      "allowManualProduction": null,
      "downtimeDetectionMode": "off",
      "utilisationDowntimeThreshold": null,
      "slowDurationThreshold": null,
      "electricalUsageStoppedThresholdKw": null,
      "allowScheduleCutShort": null,
      "productiveStatusMode": "productive_signal",
      "lineSpeedStoppedThreshold": null,
      "shiftPatternId": null,
      "productiveHoldOnTime": 1,
      "minimumCycleTime": null,
      "statusCode": null,
      "statusCodeUpdatedAt": null,
      "electricalPowerNominalKw": null,
      "shiftPattern": {
        "accountId": "text",
        "title": "text",
        "id": 1,
        "createdAt": "text",
        "updatedAt": "text",
        "code": "text",
        "duration": 1,
        "startHour": 1,
        "endHour": 1,
        "shifts": [
          {
            "shiftId": 1,
            "startHour": 1,
            "duration": 1,
            "shiftName": "text",
            "shiftPatternId": 1,
            "weekDay": "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": null,
      "stoppedSince": null,
      "state": {
        "code": "text",
        "label": "text",
        "order": 1,
        "color": "text"
      },
      "idleCostPerMinute": null,
      "moduleVisibility": [
        "utilisation"
      ],
      "cachedAt": null,
      "allowQuickScheduleStart": null,
      "speedScale": null,
      "speedOffset": null,
      "speedToProductionRatio": null,
      "forceAllShiftTimeAsPlannedProduction": true,
      "lastStationWindow": {
        "accountId": "text",
        "stationCode": "text",
        "windowStartAt": "text",
        "windowEndAt": "text",
        "totalMs": 1,
        "shiftMs": 1,
        "scheduledProductionMs": 1,
        "scheduledNonProductionMs": 1,
        "productiveMs": 1,
        "downtimeMs": 1,
        "downtimeSince": "text",
        "rssiAvg": 1,
        "productionGoodCount": 1,
        "productionBadCount": 1,
        "productionIdealCount": 1,
        "productionTargetCount": 1,
        "speed": 1,
        "isAlive": true,
        "electricalVoltsAvg": 1,
        "electricalAmpsAvg": 1,
        "electricalHzAvg": 1,
        "electricalPfAvg": 1,
        "electricalKwAvg": 1,
        "electricalKwh": 1,
        "statusCode": "text",
        "electricalCost": 1,
        "costCurrency": "text",
        "electricalCo2": 1,
        "workOrderReference": "text",
        "lostProductionCostNonProduction": 1,
        "lostProductionCostDowntime": 1,
        "lostProductionCostSpeed": 1,
        "lostProductionCostQuality": 1,
        "performanceModeFrom": "text",
        "performanceModeType": "text",
        "productionGoodValue": 1,
        "productionBadValue": 1,
        "createdAt": "text",
        "updatedAt": "text",
        "stationName": "text",
        "scheduleIds": [
          1
        ],
        "errorCodes": [
          "text"
        ],
        "downtimeIds": [
          1
        ],
        "downtimeReasonCodes": [
          "text"
        ],
        "nonProductionReasonCodes": [
          "text"
        ],
        "windowStartAtTimestamp": 1,
        "windowEndAtTimestamp": 1,
        "isFuture": true,
        "skuName": "text",
        "skuCodes": [
          "text"
        ],
        "skuGroupCodes": [
          "text"
        ],
        "lostProductionCostTotal": 1,
        "productionTotalCount": 1,
        "productionRatePerHour": 1,
        "productionRatePerHourIdeal": 1,
        "productionMs": 1
      }
    }
  ]
}

post

Authorizations

X-API-KEYstringRequired

Body

accountIdstringOptional

codestringRequired

namestring · min: 1 · max: 32Required

groupCodestringRequired

shiftPatternIdinteger · nullableOptional

minimumCycleTimeinteger · max: 43200000 · nullableOptional

speedScalenumber · min: -9999 · max: 9999 · nullableOptional

speedOffsetnumber · min: -9999 · max: 9999 · nullableOptional

speedToProductionRationumber · max: 99999 · nullableOptional

electricalPowerNominalKwnumber · nullableOptional

idleCostPerMinutenumber · max: 99999 · nullableOptional

downtimeDetectionModestring · enumOptionalDefault: utilisationPossible values:

utilisationDowntimeThresholdintegerOptional

slowDurationThresholdinteger · nullableOptional

forceAllShiftTimeAsPlannedProductionbooleanOptionalDefault: true

productiveStatusModestring · enumOptionalDefault: productive_signalPossible values:

electricalUsageStoppedThresholdKwnumber · nullableOptional

lineSpeedStoppedThresholdnumber · nullableOptional

productiveHoldOnTimeinteger · max: 86400000 · nullableOptional

allowInterruptionModebooleanOptionalDefault: false

allowManualProductionbooleanOptionalDefault: false

allowQuickScheduleStartbooleanOptionalDefault: false

allowScheduleCutShortbooleanOptionalDefault: false

currentOperatorInitialsstring · min: 3 · max: 3 · nullableOptional

statusCodestring · nullableOptional

statusCodeUpdatedAtstring · nullableOptional

cycleTimeinteger · max: 43200000 · nullableOptional

unitsPerMinuteinteger · nullableOptional

unitsPerHourinteger · nullableOptional

lineSpeedTargetnumber · max: 99999 · 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

/station

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

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

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

delete

Authorizations

X-API-KEYstringRequired

Path parameters

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

Responses

204

204 No Content

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

/station/{code}

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

No content

Last updated 8 months ago