Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Trainings > Training

Creates a Training

Creates a Training

post/api/2026-07-01/resources/trainings/trainings

Request body

namestring required

Name of the training

codestring

Code of the training

descriptionstring required

Description of the training

external_providerstring

External provider of the training

externalboolean required

External training

category_idsstring[]

List of ids of training categories

competency_idsstring[]

Competency ids of the training

author_idstring

The person that creates the training

employee_idstring

Employee identifier associated with the training

costinteger
subsidized_costinteger
cost_decimalstring
subsidized_cost_decimalstring
yearinteger required

Year of the training

company_idstring

Company identifier of the training

valid_forinteger

The training validity period in years

objectivesstring

Objectives of the course

total_durationnumber

The total duration in hours and minutes of the course

is_mandatoryboolean

This field is used to define if the training is mandatory or not

Example request

{
  "name": "Communication Course",
  "code": "COM-101",
  "description": "Intermediate-level communication course that focuses on building and enhancing language skills.",
  "external_provider": "Coursera",
  "category_ids": [
    "1",
    "20"
  ],
  "competency_ids": [
    "1",
    "2"
  ],
  "author_id": "20",
  "employee_id": "15",
  "cost_decimal": "0.0",
  "subsidized_cost_decimal": "0.0",
  "year": 2022,
  "company_id": "1",
  "valid_for": 1,
  "objectives": "Intermediate-level communication course that focuses on building and enhancing language skills.",
  "total_duration": 2.5
}

Response

CREATED

idstring required

Identifier of the course

company_idstring required

Company identifier

author_idstring required

The person that creates the training

author_employee_idstring

Employee identifier of the training author

namestring required

Name of the training

codestring

Code of the training

descriptionstring required

Description of the training

created_atstring

Creation date of the course

updated_atstring

Last modification date of the course

external_providerstring

The name of the provider if any

externalboolean required

External training

total_costinteger
fundae_subsidizedboolean required

Subsidized by Fundae

subsidizedboolean required

Marked as subsidized

costinteger required
subsidized_costinteger required
total_cost_decimalstring
cost_decimalstring required
subsidized_cost_decimalstring required
category_idsstring[]

List of ids of training categories

status'draft' | 'active' | 'deleted'

Training status. Can be one of the following values

yearinteger required

Year of the training

catalogboolean required

Visible in catalog

competency_idsstring[] required

List of ids of training competencies

total_training_coststring required

The total direct cost of all course's groups

total_training_indirect_coststring required

The total indirect cost of all course's groups

total_training_salary_coststring required

The total salary cost of all course's groups

total_training_subsidized_coststring required

The total subsidized cost of all course's groups

total_participantsinteger required

Number of participants of all course's groups

training_attendance_status'notassigned' | 'notstarted' | 'missing' | 'started' | 'partiallycompleted' | 'completed' required
valid_forinteger

Number of years this course is valid for

objectivesstring

Objectives of the course

number_of_expired_participantsinteger

Number of participants that have the course expired or about to expire in the next 3 months. Only applicable to trainings with validity period.

total_durationnumber required

The total duration in hours and minutes of the course

is_mandatoryboolean required

This field is used to define if the training is mandatory or not

Example response

{
  "id": "1",
  "company_id": "1",
  "author_id": "20",
  "author_employee_id": "15",
  "name": "Communication Course",
  "code": "COM-101",
  "description": "Intermediate-level communication course that focuses on building and enhancing language skills.",
  "created_at": "2025-02-04T10:31:48.000Z",
  "updated_at": "2025-02-04T10:31:48.000Z",
  "total_cost_decimal": "0.0",
  "cost_decimal": "0.0",
  "subsidized_cost_decimal": "0.0",
  "category_ids": [
    "1",
    "20"
  ],
  "status": "active",
  "year": 2025,
  "catalog": true,
  "competency_ids": [
    "1",
    "3"
  ],
  "total_training_cost": "0.0",
  "total_training_indirect_cost": "0.0",
  "total_training_salary_cost": "0.0",
  "total_training_subsidized_cost": "0.0",
  "training_attendance_status": "completed",
  "objectives": "Build and enhance language skills.",
  "number_of_expired_participants": 2,
  "total_duration": 2.5
}