Manufacturing · Change Control
Affected Objects
What the change touches, one line each. This is what makes an ECO auditable: not "we changed the bracket" but nine objects, from this to that, each closed by somebody.
/api/mfg/change-affectedPublished as /api/v1/change-affectedDownload specification (OpenAPI 3.1) Screen: Affected Objects
Overview
| Package | Manufacturing |
|---|---|
| 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 Manufacturing › Affected Objects 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 | mfg.change_affected · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/change-affectedList affected objects
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",
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"object_type": "item",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_ref": "text",
"object_label": "text",
"action": "add",
"from_revision": "text",
"to_revision": "text",
"change_summary": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/change-affected?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/change-affected/{id}Read one affected object
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",
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"object_type": "item",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_ref": "text",
"object_label": "text",
"action": "add",
"from_revision": "text",
"to_revision": "text",
"change_summary": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/change-affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-affectedCreate a affected object
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
change_order_id | uuid | Yes | Change order |
line_no | integer | No | Line |
object_type | text | Yes | Object type Allowed: item bom routing recipe document cad_document cam_program tool inspection_plan work_instruction supplier equipment |
item_id | uuid | No | Item |
bom_id | uuid | No | Bill of material — The version this change puts in force. Releasing the change order activates it from the order’s effective date and retires the version it replaces; action Obsolete makes it inactive instead. |
routing_id | uuid | No | Routing id |
document_id | uuid | No | Document |
object_ref | text | No | Reference |
object_label | text | No | Label |
action | text | No | Action Allowed: add revise obsolete replace no_change |
from_revision | text | No | From revision |
to_revision | text | No | To revision |
change_summary | text | No | What changes |
Sample body
{
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_type": "item",
"line_no": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"object_type": "item",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_ref": "text",
"object_label": "text",
"action": "add",
"from_revision": "text",
"to_revision": "text",
"change_summary": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/change-affected" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"change_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","object_type":"item","line_no":10,"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","routing_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/change-affected/{id}Change a affected object
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 |
|---|---|---|---|
change_order_id | uuid | Yes | Change order |
line_no | integer | No | Line |
object_type | text | Yes | Object type Allowed: item bom routing recipe document cad_document cam_program tool inspection_plan work_instruction supplier equipment |
item_id | uuid | No | Item |
bom_id | uuid | No | Bill of material — The version this change puts in force. Releasing the change order activates it from the order’s effective date and retires the version it replaces; action Obsolete makes it inactive instead. |
routing_id | uuid | No | Routing id |
document_id | uuid | No | Document |
object_ref | text | No | Reference |
object_label | text | No | Label |
action | text | No | Action Allowed: add revise obsolete replace no_change |
from_revision | text | No | From revision |
to_revision | text | No | To revision |
change_summary | text | No | What changes |
Sample body
{
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_type": "item"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"change_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"object_type": "item",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_ref": "text",
"object_label": "text",
"action": "add",
"from_revision": "text",
"to_revision": "text",
"change_summary": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/change-affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"change_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","object_type":"item"}'DELETE/api/mfg/change-affected/{id}Delete a affected object
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/mfg/change-affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-affected/{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/mfg/change-affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/mfg/change-affected/{id}/completeComplete
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):
toRevisionResponse
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/mfg/change-affected/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"toRevision":"value"}'Data model
Every field of a affected object, 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 |
change_order_id | uuid | read, write | Change order |
line_no | integer | read, write | Line |
object_type | text | read, write | Object type Allowed: item bom routing recipe document cad_document cam_program tool inspection_plan work_instruction supplier equipment |
item_id | uuid | read, write | Item |
bom_id | uuid | read, write | Bill of material — The version this change puts in force. Releasing the change order activates it from the order’s effective date and retires the version it replaces; action Obsolete makes it inactive instead. |
routing_id | uuid | read, write | Routing id |
document_id | uuid | read, write | Document |
object_ref | text | read, write | Reference |
object_label | text | read, write | Label |
action | text | read, write | Action Allowed: add revise obsolete replace no_change |
from_revision | text | read, write | From revision |
to_revision | text | read, write | To revision |
change_summary | text | read, write | What changes |
is_complete | boolean | read only | Is complete |
completed_by | uuid | read only | Completed by |
completed_at | timestamp with time zone | read only | Completed at |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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 Manufacturing › Affected Objects 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.