TRANXACT.AI Help

Manufacturing · Design & Documents

Engineering Documents

The drawing, the model, the specification and the work instruction — under change control, so a released revision is frozen and a superseded one is kept.

Type REST11 operationsBase path /api/mfg/engineering-documentsPublished as /api/v1/engineering-documents

Download specification (OpenAPI 3.1) Screen: Engineering Documents

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 › Engineering Documents 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.cad_documents · 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

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

GET/api/mfg/engineering-documentsList engineering documents

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",
      "document_no": "DOC-000001",
      "title": "Example",
      "description": "text",
      "doc_type": "drawing",
      "cad_system": "solidworks",
      "native_format": "text",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "current_revision": "text",
      "is_controlled": true,
      "retention_years": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "document_no": "DOC-000001",
  "title": "Example",
  "description": "text",
  "doc_type": "drawing",
  "cad_system": "solidworks",
  "native_format": "text",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_revision": "text",
  "is_controlled": true,
  "retention_years": 10
}

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

Sample request

curl "https://demo.tranxact.ai/api/mfg/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/engineering-documentsCreate a engineering document

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
titletextYesTitle
descriptiontextNoDescription
doc_typetextNoDocument type
Allowed: drawing model_3d assembly schematic pcb specification work_instruction test_method inspection_drawing tooling_drawing process_sheet material_spec
cad_systemtextNoCAD system
Allowed: solidworks autocad inventor catia nx creo fusion360 onshape freecad altium kicad revit
native_formattextNoNative format — SLDPRT, DWG, STEP…
item_iduuidNoItem
model_iduuidNo3D model — The mesh this document was drawn against, where there is one. Geometry lives in the model, not in a second copy here.
owner_iduuidNoOwner
is_controlledbooleanNoUnder change control — A controlled document cannot be revised without a change order. A marketing render is a CAD document and is not.
retention_yearsintegerNoRetention (years)

Sample body

{
  "title": "Example",
  "description": "text",
  "doc_type": "drawing",
  "cad_system": "solidworks",
  "native_format": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_no": "DOC-000001",
  "title": "Example",
  "description": "text",
  "doc_type": "drawing",
  "cad_system": "solidworks",
  "native_format": "text",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_revision": "text",
  "is_controlled": true,
  "retention_years": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/engineering-documents" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","description":"text","doc_type":"drawing","cad_system":"solidworks","native_format":"text"}'
PUT/api/mfg/engineering-documents/{id}Change a engineering document

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
titletextYesTitle
descriptiontextNoDescription
doc_typetextNoDocument type
Allowed: drawing model_3d assembly schematic pcb specification work_instruction test_method inspection_drawing tooling_drawing process_sheet material_spec
cad_systemtextNoCAD system
Allowed: solidworks autocad inventor catia nx creo fusion360 onshape freecad altium kicad revit
native_formattextNoNative format — SLDPRT, DWG, STEP…
item_iduuidNoItem
model_iduuidNo3D model — The mesh this document was drawn against, where there is one. Geometry lives in the model, not in a second copy here.
owner_iduuidNoOwner
is_controlledbooleanNoUnder change control — A controlled document cannot be revised without a change order. A marketing render is a CAD document and is not.
retention_yearsintegerNoRetention (years)

Sample body

{
  "title": "Example",
  "description": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_no": "DOC-000001",
  "title": "Example",
  "description": "text",
  "doc_type": "drawing",
  "cad_system": "solidworks",
  "native_format": "text",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "current_revision": "text",
  "is_controlled": true,
  "retention_years": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","description":"text"}'
DELETE/api/mfg/engineering-documents/{id}Delete a engineering document

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/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/engineering-documents/{parentId}/revisionsRevisions

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/mfg/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revisions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/engineering-documents/{parentId}/revisionsRevisions

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revisions" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/engineering-documents/{parentId}/revisions/{lineId}Revisions

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revisions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/engineering-documents/{parentId}/revisions/{lineId}Revisions

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revisions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/engineering-documents/{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/engineering-documents/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/engineering-documents/{id}/reviseRevise

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

revision*, changeOrderId, changeSummary, contentId, fileName, modelId

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/engineering-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revise" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"revision":"value","changeOrderId":"value","changeSummary":"value","contentId":"value","fileName":"value","modelId":"value"}'

Data model

Every field of a engineering document, 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
document_notextread onlyDocument no
titletextread, writeTitle
descriptiontextread, writeDescription
doc_typetextread, writeDocument type
Allowed: drawing model_3d assembly schematic pcb specification work_instruction test_method inspection_drawing tooling_drawing process_sheet material_spec
cad_systemtextread, writeCAD system
Allowed: solidworks autocad inventor catia nx creo fusion360 onshape freecad altium kicad revit
native_formattextread, writeNative format — SLDPRT, DWG, STEP…
item_iduuidread, writeItem
model_iduuidread, write3D model — The mesh this document was drawn against, where there is one. Geometry lives in the model, not in a second copy here.
owner_iduuidread, writeOwner
current_revisiontextread onlyCurrent revision
is_controlledbooleanread, writeUnder change control — A controlled document cannot be revised without a change order. A marketing render is a CAD document and is not.
retention_yearsintegerread, writeRetention (years)
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

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 › Engineering Documents 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.