HRMS · People
Organization Chart
The reporting line, graphically. Drag a person onto another to change their manager.
/api/hrms/org-chartDownload specification (OpenAPI 3.1) Screen: Organization Chart
Overview
| Package | HRMS |
|---|---|
| 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 HRMS › Organization Chart 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
POST/api/hrms/org-chart/set-managerSet manager
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/hrms/org-chart/set-manager" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/org-chart/import/applyImport apply
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/hrms/org-chart/import/apply" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/org-chart/batches/{id}/undoBatches undo
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 POST "https://demo.tranxact.ai/api/hrms/org-chart/batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/undo" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/org-chart/view/{by}View
Path parameters
| Name | Type | Description |
|---|---|---|
by | string (uuid) | The record's by, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/org-chart/view/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/org-chart/summarySummary
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/org-chart/summary" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/org-chart/import/previewImport preview
Request body
The keys this action reads (* = required; "one of" lists the only values):
rows, kind, fileName, mimeTypeResponse
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/hrms/org-chart/import/preview" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rows":"value","kind":"value","fileName":"value","mimeType":"value"}'POST/api/hrms/org-chart/import/read-imageImport read image
Request body
The keys this action reads (* = required; "one of" lists the only values):
fileName, mimeTypeResponse
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/hrms/org-chart/import/read-image" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fileName":"value","mimeType":"value"}'GET/api/hrms/org-chartRead organization chart
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/org-chart" \
-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 HRMS › Organization Chart 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.