Manufacturing · Design & Documents
Models
Geometry held as a mesh rather than a file, so it can be measured. A model that is not closed reports no volume rather than a wrong one.
/api/mfg/modelsPublished as /api/v1/modelsOverview
| 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 › Models 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 | viz.model_overview · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/modelsList models
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",
"model_no": "MOD-000001",
"name": "Example",
"domain": "text",
"source_format": "text",
"units": "text",
"vertex_count": 10,
"face_count": 10,
"volume": "1250.00",
"surface_area": "1250.00",
"is_watertight": true,
"quality_note": "text",
"revision": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/models?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/models/{id}Read one models
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",
"model_no": "MOD-000001",
"name": "Example",
"domain": "text",
"source_format": "text",
"units": "text",
"vertex_count": 10,
"face_count": 10,
"volume": "1250.00",
"surface_area": "1250.00",
"is_watertight": true,
"quality_note": "text",
"revision": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/modelsPost models
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/models" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/models/{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/models/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/models/{id}Put models
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/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/models/{id}Delete models
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/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a models, 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 |
model_no | text | read only | Model no |
name | text | read only | Name |
domain | text | read only | Domain |
source_format | text | read only | Source format |
units | text | read only | Units |
vertex_count | integer | read only | Vertex count |
face_count | integer | read only | Face count |
volume | numeric | read only | Volume |
surface_area | numeric | read only | Surface area |
is_watertight | boolean | read only | Is watertight |
quality_note | text | read only | Quality note |
revision | text | read only | Revision |
created_at | timestamp with time zone | read only | Created at |
created_by_name | text | read only | Created by name |
bbox_min | _numeric | read only | Bbox min |
bbox_max | _numeric | read only | Bbox max |
size_x | numeric | read only | Size x |
size_y | numeric | read only | Size y |
size_z | numeric | read only | Size z |
components | integer | read only | Components |
links | integer | read only | Links |
attached_to | text | read only | Attached to |
standing | text | read only | Standing |
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 › Models 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.