Manufacturing · Equipment & OEE
Andon Board
What the plant looks like right now: every machine, its state, how long it has been in it, and what it is running. The wall screen and the shift report read the same query.
Type REST1 operationsBase path
/api/mfg/andonOverview
| 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 › Andon Board 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
1 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/andonRead andon board
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/andon" \
-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 › Andon Board 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.