List a build order's requirements

GET

/build-orders/{id}/requirements

curl --request GET \
  --url https://app.buildtrace.eu/api/build-orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requirements \
  --header 'Authorization: Bearer <token>'

Required scope: production:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Media typeapplication/json

Array<object>

object

revisionId

required

string format: uuid

partCode

required

string

partName

required

string

revisionLabel

required

string

kind

required

string

isSerialized

required

boolean

need

required

Outstanding quantity this order needs, netted against the parent’s shortfall.

string

have

required

What this node can claim: the order’s own existing allocation for the line plus its share of the remaining free stock, after items earlier in the tree took theirs.

string

short

required

Max(0, need - have). Zero means nothing to do for this item.

string

freeStock

required

Free stock of this revision before the tree allocated any of it.

string

children

required

Array<object> recursive

Example ^generated

[
  {
    "revisionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "partCode": "example",
    "partName": "example",
    "revisionLabel": "example",
    "kind": "example",
    "isSerialized": true,
    "need": "example",
    "have": "example",
    "short": "example",
    "freeStock": "example",
    "children": []
  }
]

401

Unauthorized

404

Not found

409

Conflict (cyclic or conflicting BOM)

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}