Production Runs

Get Production Runs

get

Returns a list of all production runs in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

cursorstringOptional

machinestring · uuid[] · max: 50 · nullableOptional

If not set, production runs for all machines will be considered.

product-external-idstring · nullableOptional

If not set, all products will be considered.

Example: 301292

productstring · uuid · nullableOptional

If not set, all products will be considered.

Example: 4646d168-a98b-447e-834a-d36dd1f33eb4

production-order-external-idstring · nullableOptional

If not set, all production orders will be considered.

Example: FA1

startstring · date-time · nullableOptional

Only production runs being executed starting at start will be returned. If not set, no lower time bound will be assumed.

Example: 2023-07-19T19:39:46.735269+02:00

endstring · date-time · nullableOptional

Only production runs being executed up to end will be returned. If not set, no upper time bound will be assumed.

uuidstring · uuid[] · max: 50 · nullableOptional

If not set, production runs for all UUIDs will be considered.

qstring · nullableOptional

Filter production runs based on a partial match of the external id of the production order or product. Use product-external-id: and production-external-id: prefixes to specify the field to search in.

Example: product-external-id:301292Pattern: ^(?P<product_external_id>product-external-id:)(?P<product_external_id_value>.*)|^(?P<production_order_external_id>production-order-external-id:)(?P<production_order_external_id_value>.*)

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/production-runs

HTTPcURLJavaScriptPython

GET /api/v2/production-runs HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "production_order": "FA1234",
      "product": "123e4567-e89b-12d3-a456-426614174000",
      "start": "2026-07-18T10:47:12.733Z",
      "end": "2026-07-18T10:47:12.733Z",
      "average_throughput": 1,
      "quantity_total": {
        "unit": "text",
        "value": 1
      },
      "quantity_scrap": {
        "unit": "text",
        "value": 1
      },
      "quantity_yield": {
        "unit": "text",
        "value": 1
      },
      "availability": {
        "score": 1,
        "time_loss": 1
      },
      "performance": {
        "score": 1,
        "time_loss": 1
      },
      "quality": {
        "score": 1,
        "time_loss": 1
      },
      "productivity": {
        "score": 1,
        "time_loss": 1
      },
      "maximum_run_speed": {
        "value": 1,
        "observation_period_start": "2026-07-18T10:47:12.733Z",
        "observation_period_end": "2026-07-18T10:47:12.733Z",
        "unit": "text"
      },
      "data_quality": {
        "data_coverage": 1,
        "overlap_percentage": 1,
        "overlap_time": 1
      },
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Get Production Run

get

Returns details for a specific production run.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the production run.

Example: 123e4567-e89b-12d3-a456-426614174000

machinestring · uuidRequired

The UUID of the machine the production run was executed on.

production_orderstringRequired

The identifier of the production order.

Example: FA1234

productstring · uuidRequired

The UUID of the product that was produced.

startstring · date-timeRequired

The start of the production run in ISO8601 format with timezone info.

endstring · date-time · nullableRequired

The end of the production run in ISO8601 format with timezone info. If the value of this field is null, the production run is not yet finished.

average_throughputnumber · nullableRequired

The average throughput of the production run excluding downtimes.

422

Validation Error

application/json

get/v2/production-runs/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/production-runs/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "production_order": "FA1234",
  "product": "123e4567-e89b-12d3-a456-426614174000",
  "start": "2026-07-18T10:47:12.733Z",
  "end": "2026-07-18T10:47:12.733Z",
  "average_throughput": 1,
  "quantity_total": {
    "unit": "text",
    "value": 1
  },
  "quantity_scrap": {
    "unit": "text",
    "value": 1
  },
  "quantity_yield": {
    "unit": "text",
    "value": 1
  },
  "availability": {
    "score": 1,
    "time_loss": 1
  },
  "performance": {
    "score": 1,
    "time_loss": 1
  },
  "quality": {
    "score": 1,
    "time_loss": 1
  },
  "productivity": {
    "score": 1,
    "time_loss": 1
  },
  "maximum_run_speed": {
    "value": 1,
    "observation_period_start": "2026-07-18T10:47:12.733Z",
    "observation_period_end": "2026-07-18T10:47:12.733Z",
    "unit": "text"
  },
  "data_quality": {
    "data_coverage": 1,
    "overlap_percentage": 1,
    "overlap_time": 1
  },
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}