Manufacturing · Shop Floor
Confirmations
What was made at each operation, by whom and on what. Good, scrap and rework are three quantities with three costs, and setup time is separated from run time.
/api/mfg/confirmationsPublished as /api/v1/confirmationsOverview
| 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 › Confirmations 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.operation_confirmations · kept per company (and organisational unit where it has one) |
| 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/confirmationsList confirmations
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",
"confirmation_no": "CON-000001",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"op_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operator_name": "Example",
"confirmed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"qty_good": "12.0000",
"qty_scrap": "12.0000"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/confirmations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/confirmations/{id}Read one confirmation
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",
"confirmation_no": "CON-000001",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"op_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shift_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operator_name": "Example",
"confirmed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"qty_good": "12.0000",
"qty_scrap": "12.0000"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/confirmations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/confirmationsPost confirmations
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/confirmations" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/confirmations/{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/confirmations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/mfg/confirmations/{id}Put confirmations
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/mfg/confirmations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/confirmations/{id}Delete confirmations
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/mfg/confirmations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/confirmations/postPost
Request body
The keys this action reads (* = required; "one of" lists the only values):
qtyGood, qtyScrap, qtyRework, setupMinutes, runMinutes, operationId, workCenterId, equipmentId, scrapReasonId, reworkReasonId, isFinal, endedAt, startedAt, shiftId, employeeId, operatorName, laborMinutes, machineMinutes, source, deviceRef, notes, backflush; source one of manual|terminal|barcode|plc|iot|api|importResponse
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/confirmations/post" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"qtyGood":"value","qtyScrap":"value","qtyRework":"value","setupMinutes":"value","runMinutes":"value","operationId":"value"}'Data model
Every field of a confirmation, 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 |
confirmation_no | text | read only | Confirmation no |
production_order_id | uuid | read only | Production order id |
production_operation_id | uuid | read only | Production operation id |
op_no | integer | read only | Op no |
work_center_id | uuid | read only | Work center id |
equipment_id | uuid | read only | Equipment id |
shift_id | uuid | read only | Shift id |
employee_id | uuid | read only | Employee id |
operator_name | text | read only | Operator name |
confirmed_by | uuid | read only | Confirmed by |
qty_good | numeric | read only | Qty good |
qty_scrap | numeric | read only | Qty scrap |
qty_rework | numeric | read only | Qty rework |
scrap_reason_id | uuid | read only | Scrap reason id |
setup_minutes | numeric | read only | Setup minutes |
run_minutes | numeric | read only | Run minutes |
labor_minutes | numeric | read only | Labor minutes |
machine_minutes | numeric | read only | Machine minutes |
started_at | timestamp with time zone | read only | Started at |
ended_at | timestamp with time zone | read only | Ended at |
is_final | boolean | read only | Is final |
backflushed | boolean | read only | Backflushed |
journal_id | uuid | read only | Journal id |
source | text | read only | Source |
device_ref | text | read only | Device ref |
status | text | read only | Status |
reversed_by | uuid | read only | Reversed by |
notes | text | read only | 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 Manufacturing › Confirmations 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.