TRANXACT.AI Help

Manufacturing · Change Control

Change Requests

Requests to change a product or document, reviewed and approved before a change order is made.

Type REST12 operationsBase path /api/mfg/change-requestsPublished as /api/v1/change-requests

Download specification (OpenAPI 3.1) Screen: Change Requests

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 › 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.
Tablemfg.change_requests · 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

12 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/change-requestsList change requests

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

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

FieldTypeRequiredDescription
titletextYesWhat is the problem
descriptiontextNoDescription
origintextNoWhere it came from
Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure
reasontextNoReason
prioritytextNoPriority
Allowed: low medium high urgent
item_iduuidNoItem
document_iduuidNoDocument — For a request against a work instruction rather than a part.
nonconformance_notextNoNonconformance it came from
case_iduuidNoCase id
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
estimated_costnumericNoEstimated cost
estimated_saving_per_yearnumericNoEstimated saving per year
currencytextNoCurrency
affects_form_fit_functionbooleanNoAffects form, fit or function
affects_safetybooleanNoAffects safety
affects_regulatorybooleanNoAffects a regulatory claim
requested_byuuidNoRequested by
needed_bydateNoNeeded 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

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
titletextYesWhat is the problem
descriptiontextNoDescription
origintextNoWhere it came from
Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure
reasontextNoReason
prioritytextNoPriority
Allowed: low medium high urgent
item_iduuidNoItem
document_iduuidNoDocument — For a request against a work instruction rather than a part.
nonconformance_notextNoNonconformance it came from
case_iduuidNoCase id
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
estimated_costnumericNoEstimated cost
estimated_saving_per_yearnumericNoEstimated saving per year
currencytextNoCurrency
affects_form_fit_functionbooleanNoAffects form, fit or function
affects_safetybooleanNoAffects safety
affects_regulatorybooleanNoAffects a regulatory claim
requested_byuuidNoRequested by
needed_bydateNoNeeded 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

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/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/change-requests/{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/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

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

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

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

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):

decision, notes; decision one of approved|rejected|deferred

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/decide" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value","notes;":"value"}'
POST/api/mfg/change-requests/{id}/withdrawWithdraw

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
request_notextread onlyRequest no
titletextread, writeWhat is the problem
descriptiontextread, writeDescription
origintextread, writeWhere it came from
Allowed: internal customer supplier quality production regulatory cost_reduction obsolescence safety field_failure
reasontextread, writeReason
prioritytextread, writePriority
Allowed: low medium high urgent
item_iduuidread, writeItem
document_iduuidread, writeDocument — For a request against a work instruction rather than a part.
nonconformance_notextread, writeNonconformance it came from
case_iduuidread, writeCase id
supplier_iduuidread, writeSupplier
customer_iduuidread, writeCustomer
estimated_costnumericread, writeEstimated cost
estimated_saving_per_yearnumericread, writeEstimated saving per year
currencytextread, writeCurrency
affects_form_fit_functionbooleanread, writeAffects form, fit or function
affects_safetybooleanread, writeAffects safety
affects_regulatorybooleanread, writeAffects a regulatory claim
requested_byuuidread, writeRequested by
requested_attimestamp with time zoneread onlyRequested at
needed_bydateread, writeNeeded by
reviewed_byuuidread onlyReviewed by
reviewed_attimestamp with time zoneread onlyReviewed at
decision_notestextread onlyDecision notes
statustextread onlyStatus
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
submitted_byuuidread onlySubmitted by
submitted_attimestamp with time zoneread onlySubmitted at
withdrawn_byuuidread onlyWithdrawn by
withdrawn_attimestamp with time zoneread onlyWithdrawn at
board_outcometextread onlyBoard outcome
decision_overridebooleanread onlyDecision override

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 › Change Requests 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.