v1API ReferenceNominal speeds

Retrieve a nominal speed

Return one nominal-speed record by id.

Path Parameters

nominal_speed_id*Nominal Speed Id

The nominal speed ID.

Formatuuid4

Response Body

application/json

application/json

Try it live
GET
/v1/nominal-speeds/{nominal_speed_id}

This endpoint requires authentication — paste a token in the Authorization section below.

curl -X GET "https://example.com/v1/nominal-speeds/string"
{  "id": "36f7b519-d93e-4ec8-8245-7f4b8c123456",  "machine": {    "id": 1,    "name": "machine 1"  },  "sku": {    "description": "a simple description",    "id": "66844a2a-9028-4d0f-ae84-0c431f3e174e",    "name": "sku 1",    "unit": "units"  },  "nominalSpeed": 100,  "countingFactor": 1,  "createdAt": "2024-01-01T00:00:00.000Z",  "updatedAt": "2024-01-01T00:00:00.000Z",  "deletedAt": "2024-01-02T00:00:00.000Z"}

Search nominal speeds POST

Search the configured speeds for machine and SKU combinations. Useful for auditing: a machine/SKU pair with no nominal speed, or an obviously wrong one, is the most common cause of a performance figure nobody believes.

Update a nominal speed PATCH

Partially update a nominal speed: send only the fields that change. Nominal speed is the denominator of the performance term in OEE, so changing it changes the OEE reported for the periods it applies to.