Station Window

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

plantcodestring · min: 1Required

rangecodestringRequired

aggregatewindowstringOptional

stationcodesstringOptional

Comma-separated list of Station Codes.

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

/station-window

HTTPcURLJavaScriptPython

GET /api/station-window?plantcode=text&rangecode=text 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",
      "windows": [
        {
          "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,
          "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,
          "nonProductionReasonNames": [
            "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,
            "energy": 1,
            "energyCost": 1
          }
        ],
        "stops": [
          {
            "code": "text",
            "description": "text",
            "duration": 1,
            "cost": 1,
            "percent": 1,
            "energy": 1,
            "energyCost": 1
          }
        ],
        "oee": 1
      },
      "nominal": {
        "electricalPowerNominalKw": 1
      }
    }
  ],
  "range": {
    "from": 1,
    "to": 1,
    "duration": 1,
    "fromIso": "text",
    "toIso": "text",
    "durationFormatted": "text"
  }
}

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

plantcodestring · min: 1Required

rangecodestringRequired

stationcodesstringOptional

Comma-separated list of Station 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

/station-window/sku

HTTPcURLJavaScriptPython

GET /api/station-window/sku?plantcode=text&rangecode=text HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "skuCode": "text",
      "skuName": "text",
      "windows": [
        {
          "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,
          "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,
          "nonProductionReasonNames": [
            "text"
          ]
        }
      ],
      "cycleTimeAnalysis": {
        "avg": 1,
        "min": 1,
        "max": 1,
        "quantity": 1,
        "default": 1,
        "stations": [
          {
            "stationCode": "text",
            "stationName": "text",
            "avg": 1,
            "min": 1,
            "max": 1,
            "quantity": 1
          }
        ]
      }
    }
  ],
  "range": {
    "from": 1,
    "to": 1,
    "duration": 1,
    "fromIso": "text",
    "toIso": "text",
    "durationFormatted": "text"
  }
}