TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/scm/capacity-resourcesPublished as /api/v1/capacity-resources

Download specification (OpenAPI 3.1) Screen: Capacity Resources

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablescm.capacity_resources · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
resource_kindtextNoKind
work_center_iduuidNoWork center — A capacity resource is a planning view of something that already exists, not a second master.
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
warehouse_resource_iduuidNoWarehouse resource
supplier_iduuidNoSupplier
capacity_uomtextNoMeasured in
Allowed: hours units kg pallets stops km shifts
daily_capacitynumericNoCapacity a day
parallel_capacityintegerNoJobs at once
efficiency_pctnumericNoEfficiency % — Real capacity is never nameplate capacity. This is the difference.
utilization_target_pctnumericNoTarget utilization %
setup_minutesnumericNoSetup minutes
teardown_minutesnumericNoTeardown minutes
is_constraintbooleanNoTreat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints.
allow_overloadbooleanNoMay be overloaded
max_overload_pctnumericNoMaximum overload %
cost_per_hournumericNoCost an hour
overtime_cost_per_hournumericNoOvertime cost an hour
currencytextNoCurrency
calendar_codetextNoCalendar
is_activebooleanNoActive
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
resource_kindtextNoKind
work_center_iduuidNoWork center — A capacity resource is a planning view of something that already exists, not a second master.
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
vehicle_iduuidNoVehicle
driver_iduuidNoDriver
warehouse_resource_iduuidNoWarehouse resource
supplier_iduuidNoSupplier
capacity_uomtextNoMeasured in
Allowed: hours units kg pallets stops km shifts
daily_capacitynumericNoCapacity a day
parallel_capacityintegerNoJobs at once
efficiency_pctnumericNoEfficiency % — Real capacity is never nameplate capacity. This is the difference.
utilization_target_pctnumericNoTarget utilization %
setup_minutesnumericNoSetup minutes
teardown_minutesnumericNoTeardown minutes
is_constraintbooleanNoTreat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints.
allow_overloadbooleanNoMay be overloaded
max_overload_pctnumericNoMaximum overload %
cost_per_hournumericNoCost an hour
overtime_cost_per_hournumericNoOvertime cost an hour
currencytextNoCurrency
calendar_codetextNoCalendar
is_activebooleanNoActive
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
resource_kindtextread, writeKind
work_center_iduuidread, writeWork center — A capacity resource is a planning view of something that already exists, not a second master.
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation id
vehicle_iduuidread, writeVehicle
driver_iduuidread, writeDriver
warehouse_resource_iduuidread, writeWarehouse resource
supplier_iduuidread, writeSupplier
capacity_uomtextread, writeMeasured in
Allowed: hours units kg pallets stops km shifts
daily_capacitynumericread, writeCapacity a day
parallel_capacityintegerread, writeJobs at once
efficiency_pctnumericread, writeEfficiency % — Real capacity is never nameplate capacity. This is the difference.
utilization_target_pctnumericread, writeTarget utilization %
setup_minutesnumericread, writeSetup minutes
teardown_minutesnumericread, writeTeardown minutes
is_constraintbooleanread, writeTreat as a constraint — A bottleneck-only run treats exactly the resources marked here as constraints.
allow_overloadbooleanread, writeMay be overloaded
max_overload_pctnumericread, writeMaximum overload %
cost_per_hournumericread, writeCost an hour
overtime_cost_per_hournumericread, writeOvertime cost an hour
currencytextread, writeCurrency
calendar_codetextread, writeCalendar
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Capacity Resources for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.