TRANXACT.AI Help

Manufacturing · Batch Manufacturing

Recipe Phases

The instruction as it is read on the floor. Held as text rather than as a reference because the executed copy has to be the one that was approved.

Type REST6 operationsBase path /api/mfg/recipe-phasesPublished as /api/v1/recipe-phases

Download specification (OpenAPI 3.1) Screen: Recipe Phases

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 › Recipe Phases 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.recipe_phases · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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/mfg/recipe-phasesList recipe phases

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",
      "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "phase_no": 10,
      "name": "Example",
      "phase_type": "charge",
      "instruction": "text",
      "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "expected_minutes": "1250.00",
      "is_critical": true,
      "requires_signature": true,
      "requires_second_check": true,
      "allow_parallel": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/recipe-phases?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/recipe-phases/{id}Read one recipe phase

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "phase_no": 10,
  "name": "Example",
  "phase_type": "charge",
  "instruction": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_minutes": "1250.00",
  "is_critical": true,
  "requires_signature": true,
  "requires_second_check": true,
  "allow_parallel": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/mfg/recipe-phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/recipe-phasesCreate a recipe phase

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
recipe_iduuidYesRecipe
phase_nointegerYesPhase number
nametextYesName
phase_typetextNoType
Allowed: charge mix heat cool hold transfer sample inspect clean package process other
instructiontextNoInstruction
document_iduuidNoWork instruction
work_center_iduuidNoWork center
equipment_iduuidNoMachine
expected_minutesnumericNoExpected minutes
is_criticalbooleanNoCritical phase
requires_signaturebooleanNoRequires a signature
requires_second_checkbooleanNoRequires a second check
allow_parallelbooleanNoMay run before earlier phases finish
material_item_iduuidNoMaterial charged
material_qty_per_batchnumericNoQuantity per batch

Sample body

{
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "phase_no": 10,
  "name": "Example",
  "phase_type": "charge",
  "instruction": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "phase_no": 10,
  "name": "Example",
  "phase_type": "charge",
  "instruction": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_minutes": "1250.00",
  "is_critical": true,
  "requires_signature": true,
  "requires_second_check": true,
  "allow_parallel": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/recipe-phases" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recipe_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","phase_no":10,"name":"Example","phase_type":"charge","instruction":"text","document_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/recipe-phases/{id}Change a recipe phase

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
recipe_iduuidYesRecipe
phase_nointegerYesPhase number
nametextYesName
phase_typetextNoType
Allowed: charge mix heat cool hold transfer sample inspect clean package process other
instructiontextNoInstruction
document_iduuidNoWork instruction
work_center_iduuidNoWork center
equipment_iduuidNoMachine
expected_minutesnumericNoExpected minutes
is_criticalbooleanNoCritical phase
requires_signaturebooleanNoRequires a signature
requires_second_checkbooleanNoRequires a second check
allow_parallelbooleanNoMay run before earlier phases finish
material_item_iduuidNoMaterial charged
material_qty_per_batchnumericNoQuantity per batch

Sample body

{
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "phase_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "phase_no": 10,
  "name": "Example",
  "phase_type": "charge",
  "instruction": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_minutes": "1250.00",
  "is_critical": true,
  "requires_signature": true,
  "requires_second_check": true,
  "allow_parallel": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/recipe-phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recipe_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","phase_no":10}'
DELETE/api/mfg/recipe-phases/{id}Delete a recipe phase

Path parameters

NameTypeDescription
idstring (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/recipe-phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/recipe-phases/{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/recipe-phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a recipe phase, 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
recipe_iduuidread, writeRecipe
phase_nointegerread, writePhase number
nametextread, writeName
phase_typetextread, writeType
Allowed: charge mix heat cool hold transfer sample inspect clean package process other
instructiontextread, writeInstruction
document_iduuidread, writeWork instruction
work_center_iduuidread, writeWork center
equipment_iduuidread, writeMachine
expected_minutesnumericread, writeExpected minutes
is_criticalbooleanread, writeCritical phase
requires_signaturebooleanread, writeRequires a signature
requires_second_checkbooleanread, writeRequires a second check
allow_parallelbooleanread, writeMay run before earlier phases finish
material_item_iduuidread, writeMaterial charged
material_qty_per_batchnumericread, writeQuantity per batch
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Recipe Phases 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.