Manufacturing · Services and actions
Viz
The viz service of Manufacturing: 7 operation(s).
/api/mfg/vizOverview
| 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 › Viz 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. |
| Rules | The 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.
POST/api/mfg/viz/models/importModels import
Request body
The keys this action reads (* = required; "one of" lists the only values):
fileName, contentBase64*, name, domain, units, descriptionResponse
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/viz/models/import" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fileName":"value","contentBase64":"value","name":"value","domain":"value","units":"value","description":"value"}'POST/api/mfg/viz/models/primitiveModels primitive
Request body
The keys this action reads (* = required; "one of" lists the only values):
kind, size, segments, name, domain, unitsResponse
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/viz/models/primitive" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"kind":"value","size":"value","segments":"value","name":"value","domain":"value","units":"value"}'GET/api/mfg/viz/models/{id}/meshModels mesh
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/viz/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mesh" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/viz/models/{id}/exportModels export
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/viz/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/viz/models/{id}/linkModels link
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):
module*, resource, recordId, relation, note; relation one of geometry|as_designed|as_built|work_instruction|inspection_reference|pre_operative|post_operative|planning|fixtureResponse
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/viz/models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/link" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"module":"value","resource":"value","recordId":"value","relation":"value","note;":"value"}'GET/api/mfg/viz/modelsModels
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/viz/models" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/viz/for-recordFor record
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/viz/for-record" \
-H "Authorization: Bearer $TOKEN"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 › Viz 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.