TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/hrms/training-rulesPublished as /api/v1/training-rules

Download specification (OpenAPI 3.1) Screen: Training Assignment Rules

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.training_assignment_rules · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
nametextYesName
course_iduuidNoCourse — A course, or a learning path below -- one of the two.
path_iduuidNoLearning path
job_iduuidNoJob — Blank criteria reach anybody; filled ones must all match.
position_iduuidNoPosition
org_unit_iduuidNoDepartment
include_sub_unitsbooleanNoAnd the units under it
location_iduuidNoLocation
employment_typetextNoEmployment type
Allowed: full_time part_time temporary contractor intern
new_hire_onlybooleanNoNew hires only
new_hire_within_daysintegerNoHired within (days)
due_daysintegerNoDays to complete — From the day it is assigned (for new hires, from the hire date).
recurrence_monthsintegerNoRepeat every (months) — Blank is once. A completion is re-opened when the next round falls due.
remind_days_beforeintegerNoRemind (days before due)
escalate_days_afterintegerNoTell the manager (days overdue)
is_activebooleanNoActive
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
course_iduuidNoCourse — A course, or a learning path below -- one of the two.
path_iduuidNoLearning path
job_iduuidNoJob — Blank criteria reach anybody; filled ones must all match.
position_iduuidNoPosition
org_unit_iduuidNoDepartment
include_sub_unitsbooleanNoAnd the units under it
location_iduuidNoLocation
employment_typetextNoEmployment type
Allowed: full_time part_time temporary contractor intern
new_hire_onlybooleanNoNew hires only
new_hire_within_daysintegerNoHired within (days)
due_daysintegerNoDays to complete — From the day it is assigned (for new hires, from the hire date).
recurrence_monthsintegerNoRepeat every (months) — Blank is once. A completion is re-opened when the next round falls due.
remind_days_beforeintegerNoRemind (days before due)
escalate_days_afterintegerNoTell the manager (days overdue)
is_activebooleanNoActive
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
rule_notextread onlyRule no
nametextread, writeName
course_iduuidread, writeCourse — A course, or a learning path below -- one of the two.
path_iduuidread, writeLearning path
job_iduuidread, writeJob — Blank criteria reach anybody; filled ones must all match.
position_iduuidread, writePosition
org_unit_iduuidread, writeDepartment
include_sub_unitsbooleanread, writeAnd the units under it
location_iduuidread, writeLocation
employment_typetextread, writeEmployment type
Allowed: full_time part_time temporary contractor intern
new_hire_onlybooleanread, writeNew hires only
new_hire_within_daysintegerread, writeHired within (days)
due_daysintegerread, writeDays to complete — From the day it is assigned (for new hires, from the hire date).
recurrence_monthsintegerread, writeRepeat every (months) — Blank is once. A completion is re-opened when the next round falls due.
remind_days_beforeintegerread, writeRemind (days before due)
escalate_days_afterintegerread, writeTell the manager (days overdue)
is_activebooleanread, writeActive
last_run_attimestamp with time zoneread onlyLast run at
last_run_enrolledintegerread onlyLast run enrolled
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Training Assignment Rules for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.