API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · training_requirements

Training Requirement Schema

Schema-ID
training_requirement
Collection
training_requirements
Permissions
  • Lesentraining_requirement_view
  • Anlegentraining_requirement_create
  • Änderntraining_requirement_edit
  • Löschentraining_requirement_delete

Felder

Training Requirement Schema

training_requirements4 Permissions

Rule that makes a training mandatory for a group of employees (Schulungspflicht) and generates training assignments

titlestringerforderlich
1–300 Zeichen
descriptionstringoptional
max 5000 Zeichennullable
activebooleanoptional

Inactive rules generate no new assignments; existing ones stay

Default: true
typestringoptional
Werte
MANDATORYRECOMMENDED
Default: "MANDATORY"
courseIduuidoptional

Academy course (own or shared). Null for an external training.

nullable
sourceTenantIdstringoptional

Owner tenant when courseId is a course shared into this tenant

max 64 Zeichennullable
shareIduuidoptional
nullable
courseTitlestringoptional
max 500 Zeichennullable
isExternalbooleanoptional
Default: false
externalTrainingNamestringoptional
max 500 Zeichennullable
externalProviderstringoptional
max 500 Zeichennullable
targetModestringerforderlich
Werte
ALL_EMPLOYEESORG_UNITSEMPLOYEES
orgUnitIdsuuid[]optional
max 200 ItemsDefault: []
employeeIdsuuid[]optional
max 5000 ItemsDefault: []
includeNewHiresbooleanoptional

Assign automatically to employees who enter the scope later

Default: true
dueModestringerforderlich
Werte
FIXED_DATEDAYS_AFTER_ASSIGNMENTDAYS_AFTER_HIRE
dueDatedateoptional

FIXED_DATE: deadline for everybody assigned before it

nullable
dueDaysnumberoptional

DAYS_AFTER_ASSIGNMENT / DAYS_AFTER_HIRE: completion window in days

1 – 730nullable
recurrenceMonthsnumberoptional

Repeat every N months after completion (e.g. 12 = annual refresher)

1 – 120nullable
lastAppliedAtdatetimeoptional

Last time assignments were generated from this rule

nullable
notesstringoptional
max 5000 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/training_requirements — Liste, paginiert + filterbar
  • GET /api/v1/training_requirements/<id> — Einzelne Entity
  • POST /api/v1/training_requirements — Anlegen
  • PATCH /api/v1/training_requirements/<id> — Teil-Update
  • DELETE /api/v1/training_requirements/<id> — Soft-Delete
  • GET /api/v1/training_requirements/<id>/timeline — Audit + Aktivitäten

Suche