Manufacturing · Change Control
Change Requests
Requests to change a product or document, reviewed and approved before a change order is made.
/api/mfg/change-requestsPublished as /api/v1/change-requestsDownload specification (OpenAPI 3.1) Screen: Change Requests
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 › Change Requests 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_requests · 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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/change-requestsList change requests
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",
"request_no": "REQ-000001",
"title": "Example",
"description": "text",
"origin": "internal",
"reason": "text",
"priority": "low",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"nonconformance_no": "NON-000001",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/change-requests?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/change-requests/{id}Read one change request
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",
"request_no": "REQ-000001",
"title": "Example",
"description": "text",
"origin": "internal",
"reason": "text",
"priority": "low",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"nonconformance_no": "NON-000001",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requestsCreate a change request
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | What is the problem |
description | text | No | Description |
origin | text | No | Where it came from Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure |
reason | text | No | Reason |
priority | text | No | Priority Allowed: low medium high urgent |
item_id | uuid | No | Item |
document_id | uuid | No | Document — For a request against a work instruction rather than a part. |
nonconformance_no | text | No | Nonconformance it came from |
case_id | uuid | No | Case id |
supplier_id | uuid | No | Supplier |
customer_id | uuid | No | Customer |
estimated_cost | numeric | No | Estimated cost |
estimated_saving_per_year | numeric | No | Estimated saving per year |
currency | text | No | Currency |
affects_form_fit_function | boolean | No | Affects form, fit or function |
affects_safety | boolean | No | Affects safety |
affects_regulatory | boolean | No | Affects a regulatory claim |
requested_by | uuid | No | Requested by |
needed_by | date | No | Needed by |
Sample body
{
"title": "Example",
"description": "text",
"origin": "internal",
"reason": "text",
"priority": "low"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"title": "Example",
"description": "text",
"origin": "internal",
"reason": "text",
"priority": "low",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"nonconformance_no": "NON-000001",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/change-requests" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text","origin":"internal","reason":"text","priority":"low"}'PUT/api/mfg/change-requests/{id}Change a change request
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 |
|---|---|---|---|
title | text | Yes | What is the problem |
description | text | No | Description |
origin | text | No | Where it came from Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure |
reason | text | No | Reason |
priority | text | No | Priority Allowed: low medium high urgent |
item_id | uuid | No | Item |
document_id | uuid | No | Document — For a request against a work instruction rather than a part. |
nonconformance_no | text | No | Nonconformance it came from |
case_id | uuid | No | Case id |
supplier_id | uuid | No | Supplier |
customer_id | uuid | No | Customer |
estimated_cost | numeric | No | Estimated cost |
estimated_saving_per_year | numeric | No | Estimated saving per year |
currency | text | No | Currency |
affects_form_fit_function | boolean | No | Affects form, fit or function |
affects_safety | boolean | No | Affects safety |
affects_regulatory | boolean | No | Affects a regulatory claim |
requested_by | uuid | No | Requested by |
needed_by | date | No | Needed by |
Sample body
{
"title": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"title": "Example",
"description": "text",
"origin": "internal",
"reason": "text",
"priority": "low",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"nonconformance_no": "NON-000001",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text"}'DELETE/api/mfg/change-requests/{id}Delete a change request
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-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requests/{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-requests/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-requests/{id}/submitSubmit
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 POST "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requests/{id}/assign-approversAssign approvers
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 POST "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign-approvers" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requests/{id}/signSign
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 POST "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sign" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requests/{id}/decideDecide
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):
decision, notes; decision one of approved|rejected|deferredResponse
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-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"decision":"value","notes;":"value"}'POST/api/mfg/change-requests/{id}/withdrawWithdraw
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 POST "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/withdraw" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/change-requests/{id}/reopenReopen
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 POST "https://demo.tranxact.ai/api/mfg/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reopen" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a change request, 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 |
request_no | text | read only | Request no |
title | text | read, write | What is the problem |
description | text | read, write | Description |
origin | text | read, write | Where it came from Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure |
reason | text | read, write | Reason |
priority | text | read, write | Priority Allowed: low medium high urgent |
item_id | uuid | read, write | Item |
document_id | uuid | read, write | Document — For a request against a work instruction rather than a part. |
nonconformance_no | text | read, write | Nonconformance it came from |
case_id | uuid | read, write | Case id |
supplier_id | uuid | read, write | Supplier |
customer_id | uuid | read, write | Customer |
estimated_cost | numeric | read, write | Estimated cost |
estimated_saving_per_year | numeric | read, write | Estimated saving per year |
currency | text | read, write | Currency |
affects_form_fit_function | boolean | read, write | Affects form, fit or function |
affects_safety | boolean | read, write | Affects safety |
affects_regulatory | boolean | read, write | Affects a regulatory claim |
requested_by | uuid | read, write | Requested by |
requested_at | timestamp with time zone | read only | Requested at |
needed_by | date | read, write | Needed by |
reviewed_by | uuid | read only | Reviewed by |
reviewed_at | timestamp with time zone | read only | Reviewed at |
decision_notes | text | read only | Decision notes |
status | text | read only | Status |
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 |
submitted_by | uuid | read only | Submitted by |
submitted_at | timestamp with time zone | read only | Submitted at |
withdrawn_by | uuid | read only | Withdrawn by |
withdrawn_at | timestamp with time zone | read only | Withdrawn at |
board_outcome | text | read only | Board outcome |
decision_override | boolean | read only | Decision override |
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 › Change Requests 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.