HRMS · Learning
Training Assignment Rules
Who must take a course or a learning path -- by job, position, department, location or as new hires -- by when, and how often again. Run daily, or now.
/api/hrms/training-rulesPublished as /api/v1/training-rulesDownload specification (OpenAPI 3.1) Screen: Training Assignment Rules
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 › Training Assignment Rules 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 | hr.training_assignment_rules · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| 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.
GET/api/hrms/training-rulesList training assignment rules
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",
"rule_no": "RUL-000001",
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"path_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"include_sub_units": true,
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "full_time",
"new_hire_only": true,
"new_hire_within_days": 10,
"due_days": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/training-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/training-rules/{id}Read one training rules
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",
"rule_no": "RUL-000001",
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"path_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"include_sub_units": true,
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "full_time",
"new_hire_only": true,
"new_hire_within_days": 10,
"due_days": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/training-rulesCreate a training rules
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
course_id | uuid | No | Course — A course, or a learning path below -- one of the two. |
path_id | uuid | No | Learning path |
job_id | uuid | No | Job — Blank criteria reach anybody; filled ones must all match. |
position_id | uuid | No | Position |
org_unit_id | uuid | No | Department |
include_sub_units | boolean | No | And the units under it |
location_id | uuid | No | Location |
employment_type | text | No | Employment type Allowed: full_time part_time temporary contractor intern |
new_hire_only | boolean | No | New hires only |
new_hire_within_days | integer | No | Hired within (days) |
due_days | integer | No | Days to complete — From the day it is assigned (for new hires, from the hire date). |
recurrence_months | integer | No | Repeat every (months) — Blank is once. A completion is re-opened when the next round falls due. |
remind_days_before | integer | No | Remind (days before due) |
escalate_days_after | integer | No | Tell the manager (days overdue) |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"path_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rule_no": "RUL-000001",
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"path_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"include_sub_units": true,
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "full_time",
"new_hire_only": true,
"new_hire_within_days": 10,
"due_days": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/training-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","course_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","path_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/training-rules/{id}Change a training rules
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
course_id | uuid | No | Course — A course, or a learning path below -- one of the two. |
path_id | uuid | No | Learning path |
job_id | uuid | No | Job — Blank criteria reach anybody; filled ones must all match. |
position_id | uuid | No | Position |
org_unit_id | uuid | No | Department |
include_sub_units | boolean | No | And the units under it |
location_id | uuid | No | Location |
employment_type | text | No | Employment type Allowed: full_time part_time temporary contractor intern |
new_hire_only | boolean | No | New hires only |
new_hire_within_days | integer | No | Hired within (days) |
due_days | integer | No | Days to complete — From the day it is assigned (for new hires, from the hire date). |
recurrence_months | integer | No | Repeat every (months) — Blank is once. A completion is re-opened when the next round falls due. |
remind_days_before | integer | No | Remind (days before due) |
escalate_days_after | integer | No | Tell the manager (days overdue) |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rule_no": "RUL-000001",
"name": "Example",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"path_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"include_sub_units": true,
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "full_time",
"new_hire_only": true,
"new_hire_within_days": 10,
"due_days": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","course_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/hrms/training-rules/{id}Delete a training rules
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/hrms/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/training-rules/{id}/previewPreview
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/hrms/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/training-rules/{id}/runRun
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/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/training-rules/{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/hrms/training-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a training rules, 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 |
rule_no | text | read only | Rule no |
name | text | read, write | Name |
course_id | uuid | read, write | Course — A course, or a learning path below -- one of the two. |
path_id | uuid | read, write | Learning path |
job_id | uuid | read, write | Job — Blank criteria reach anybody; filled ones must all match. |
position_id | uuid | read, write | Position |
org_unit_id | uuid | read, write | Department |
include_sub_units | boolean | read, write | And the units under it |
location_id | uuid | read, write | Location |
employment_type | text | read, write | Employment type Allowed: full_time part_time temporary contractor intern |
new_hire_only | boolean | read, write | New hires only |
new_hire_within_days | integer | read, write | Hired within (days) |
due_days | integer | read, write | Days to complete — From the day it is assigned (for new hires, from the hire date). |
recurrence_months | integer | read, write | Repeat every (months) — Blank is once. A completion is re-opened when the next round falls due. |
remind_days_before | integer | read, write | Remind (days before due) |
escalate_days_after | integer | read, write | Tell the manager (days overdue) |
is_active | boolean | read, write | Active |
last_run_at | timestamp with time zone | read only | Last run at |
last_run_enrolled | integer | read only | Last run enrolled |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
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 › Training Assignment Rules 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.