TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/mfg/confirmationsPublished as /api/v1/confirmations

Download specification (OpenAPI 3.1) Screen: Confirmations

Overview

PackageManufacturing
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 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.
Tablemfg.operation_confirmations · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

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",
      "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

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",
  "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

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

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
confirmation_notextread onlyConfirmation no
production_order_iduuidread onlyProduction order id
production_operation_iduuidread onlyProduction operation id
op_nointegerread onlyOp no
work_center_iduuidread onlyWork center id
equipment_iduuidread onlyEquipment id
shift_iduuidread onlyShift id
employee_iduuidread onlyEmployee id
operator_nametextread onlyOperator name
confirmed_byuuidread onlyConfirmed by
qty_goodnumericread onlyQty good
qty_scrapnumericread onlyQty scrap
qty_reworknumericread onlyQty rework
scrap_reason_iduuidread onlyScrap reason id
setup_minutesnumericread onlySetup minutes
run_minutesnumericread onlyRun minutes
labor_minutesnumericread onlyLabor minutes
machine_minutesnumericread onlyMachine minutes
started_attimestamp with time zoneread onlyStarted at
ended_attimestamp with time zoneread onlyEnded at
is_finalbooleanread onlyIs final
backflushedbooleanread onlyBackflushed
journal_iduuidread onlyJournal id
sourcetextread onlySource
device_reftextread onlyDevice ref
statustextread onlyStatus
reversed_byuuidread onlyReversed by
notestextread onlyNotes
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 Manufacturing › Confirmations 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.