Supply Chain · Capacity & Scheduling
Capacity Resources
Anything with a finite amount of time in it: a work center, a crew, a vehicle, a driver. One list for all of them, because a factory whose bottleneck is its delivery fleet is a real and common situation.
/api/scm/capacity-resourcesPublished as /api/v1/capacity-resourcesDownload specification (OpenAPI 3.1) Screen: Capacity Resources
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Capacity Resources on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | scm.capacity_resources · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/capacity-resourcesList capacity resources
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"resource_kind": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_uom": "hours",
"daily_capacity": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/capacity-resources?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/capacity-resources/{id}Read one capacity resource
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"resource_kind": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_uom": "hours",
"daily_capacity": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/capacity-resourcesCreate a capacity resource
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
resource_kind | text | No | Kind |
work_center_id | uuid | No | Work center — A capacity resource is a planning view of something that already exists, not a second master. |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
vehicle_id | uuid | No | Vehicle |
driver_id | uuid | No | Driver |
warehouse_resource_id | uuid | No | Warehouse resource |
supplier_id | uuid | No | Supplier |
capacity_uom | text | No | Measured in Allowed: hours units kg pallets stops km shifts |
daily_capacity | numeric | No | Capacity a day |
parallel_capacity | integer | No | Jobs at once |
efficiency_pct | numeric | No | Efficiency % — Real capacity is never nameplate capacity. This is the difference. |
utilization_target_pct | numeric | No | Target utilization % |
setup_minutes | numeric | No | Setup minutes |
teardown_minutes | numeric | No | Teardown minutes |
is_constraint | boolean | No | Treat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints. |
allow_overload | boolean | No | May be overloaded |
max_overload_pct | numeric | No | Maximum overload % |
cost_per_hour | numeric | No | Cost an hour |
overtime_cost_per_hour | numeric | No | Overtime cost an hour |
currency | text | No | Currency |
calendar_code | text | No | Calendar |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example",
"resource_kind": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"resource_kind": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_uom": "hours",
"daily_capacity": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/capacity-resources" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","resource_kind":"text","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/capacity-resources/{id}Change a capacity resource
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
resource_kind | text | No | Kind |
work_center_id | uuid | No | Work center — A capacity resource is a planning view of something that already exists, not a second master. |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
vehicle_id | uuid | No | Vehicle |
driver_id | uuid | No | Driver |
warehouse_resource_id | uuid | No | Warehouse resource |
supplier_id | uuid | No | Supplier |
capacity_uom | text | No | Measured in Allowed: hours units kg pallets stops km shifts |
daily_capacity | numeric | No | Capacity a day |
parallel_capacity | integer | No | Jobs at once |
efficiency_pct | numeric | No | Efficiency % — Real capacity is never nameplate capacity. This is the difference. |
utilization_target_pct | numeric | No | Target utilization % |
setup_minutes | numeric | No | Setup minutes |
teardown_minutes | numeric | No | Teardown minutes |
is_constraint | boolean | No | Treat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints. |
allow_overload | boolean | No | May be overloaded |
max_overload_pct | numeric | No | Maximum overload % |
cost_per_hour | numeric | No | Cost an hour |
overtime_cost_per_hour | numeric | No | Overtime cost an hour |
currency | text | No | Currency |
calendar_code | text | No | Calendar |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"resource_kind": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"vehicle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"driver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_uom": "hours",
"daily_capacity": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/capacity-resources/{id}Delete a capacity resource
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/capacity-resources/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/scm/capacity-resources/{parentId}/calendarCalendar
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/capacity-resources/{parentId}/calendarCalendar
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/capacity-resources/{parentId}/calendar/{lineId}Calendar
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/capacity-resources/{parentId}/calendar/{lineId}Calendar
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/capacity-resources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a capacity resource, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
resource_kind | text | read, write | Kind |
work_center_id | uuid | read, write | Work center — A capacity resource is a planning view of something that already exists, not a second master. |
warehouse_id | uuid | read, write | Warehouse |
location_id | uuid | read, write | Location id |
vehicle_id | uuid | read, write | Vehicle |
driver_id | uuid | read, write | Driver |
warehouse_resource_id | uuid | read, write | Warehouse resource |
supplier_id | uuid | read, write | Supplier |
capacity_uom | text | read, write | Measured in Allowed: hours units kg pallets stops km shifts |
daily_capacity | numeric | read, write | Capacity a day |
parallel_capacity | integer | read, write | Jobs at once |
efficiency_pct | numeric | read, write | Efficiency % — Real capacity is never nameplate capacity. This is the difference. |
utilization_target_pct | numeric | read, write | Target utilization % |
setup_minutes | numeric | read, write | Setup minutes |
teardown_minutes | numeric | read, write | Teardown minutes |
is_constraint | boolean | read, write | Treat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints. |
allow_overload | boolean | read, write | May be overloaded |
max_overload_pct | numeric | read, write | Maximum overload % |
cost_per_hour | numeric | read, write | Cost an hour |
overtime_cost_per_hour | numeric | read, write | Overtime cost an hour |
currency | text | read, write | Currency |
calendar_code | text | read, write | Calendar |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Capacity Resources for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.