Supply Chain · Product Configurator
Configured · Routing
The operations a configuration resolved to, in sequence, with the work centre, the time the rules computed and what each costs. A galvanizing operation that is not there is the answer to “why is this one cheaper”.
/api/scm/resolved-operationsPublished as /api/v1/resolved-operationsDownload specification (OpenAPI 3.1) Screen: Configured · Routing
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 › Configured · Routing 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 | cpq.resolved_operations |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/resolved-operationsList configured · routing
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",
"config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"op_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"setup_minutes": "1250.00",
"run_minutes_per_unit": "1250.00",
"predecessor_op_no": 10,
"is_subcontracted": true,
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subcontract_cost": "1250.00",
"subcontract_lead_days": 10,
"setup_cost": "1250.00",
"labor_cost": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/resolved-operations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/resolved-operations/{id}Read one resolved operation
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",
"config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"op_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"setup_minutes": "1250.00",
"run_minutes_per_unit": "1250.00",
"predecessor_op_no": 10,
"is_subcontracted": true,
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subcontract_cost": "1250.00",
"subcontract_lead_days": 10,
"setup_cost": "1250.00",
"labor_cost": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/resolved-operations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/resolved-operationsPost configured · routing
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/resolved-operations" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/resolved-operations/{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/resolved-operations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/scm/resolved-operations/{id}Put configured · routing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/resolved-operations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/resolved-operations/{id}Delete configured · routing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/resolved-operations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a resolved operation, 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 |
config_id | uuid | read only | Config id |
op_no | integer | read only | Op no |
work_center_id | uuid | read only | Work center id |
description | text | read only | Description |
setup_minutes | numeric | read only | Setup minutes |
run_minutes_per_unit | numeric | read only | Run minutes per unit |
predecessor_op_no | integer | read only | Predecessor op no |
is_subcontracted | boolean | read only | Is subcontracted |
supplier_id | uuid | read only | Supplier id |
subcontract_cost | numeric | read only | Subcontract cost |
subcontract_lead_days | integer | read only | Subcontract lead days |
setup_cost | numeric | read only | Setup cost |
labor_cost | numeric | read only | Labor cost |
machine_cost | numeric | read only | Machine cost |
overhead_cost | numeric | read only | Overhead cost |
outside_cost | numeric | read only | Outside cost |
requires_inspection | boolean | read only | Requires inspection |
inspection_plan_id | uuid | read only | Inspection plan id |
source | text | read only | Source |
source_rule_id | uuid | read only | Source rule id |
formula | text | read only | Formula |
explanation | text | read only | Explanation |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 › Configured · Routing 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.