Skip to main content
GET
/
talent-training
/
api
/
v2
/
training-demands
List training-demands
curl --request GET \
  --url https://{host}/talent-training/api/v2/training-demands \
  --header 'Authorization: <authorization>'
{
  "count": 1,
  "prev": "<string>",
  "next": "<string>",
  "items": [
    {
      "id": 123,
      "training": {
        "id": 1,
        "title": "<string>",
        "level": "Invalid"
      },
      "provider": {
        "id": 1,
        "name": "<string>",
        "url": "<string>"
      },
      "author": {
        "id": 2,
        "firstName": "<string>",
        "lastName": "<string>",
        "type": "Invalid"
      },
      "owner": {
        "id": 2,
        "firstName": "<string>",
        "lastName": "<string>",
        "picture": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "href": "<string>"
        },
        "establishmentId": 1,
        "departmentId": "<unknown>",
        "manager": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>"
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "state": "Invalid",
      "reason": "<string>",
      "plan": {
        "id": 1,
        "name": "<string>",
        "startOn": "2023-12-25"
      },
      "registeredOn": "2023-12-25",
      "session": {
        "id": 1,
        "startOn": "2023-12-25",
        "endOn": "2023-12-25",
        "durationInHours": 123,
        "location": {
          "isOnSite": true,
          "isRemote": true,
          "address": "<string>",
          "remoteUrl": "<string>"
        }
      },
      "prioritization": {
        "id": 1,
        "name": "<string>",
        "level": "Invalid",
        "lastModifiedAt": "2023-11-07T05:31:56Z"
      },
      "status": "Invalid"
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
ownerId
integer<int32>

Identifier of the employee that should attend this training session.

Required range: x >= 1
​
sessionId
integer<int32>

Identifier of the training session

Required range: x >= 1
​
states
enum<string>[]

Only retrieve training-demands at one of the given states.

Required array length: 1 - 4 elements

State the training-demand is in.

  • Invalid: Training-demand is invalid.
  • Requested: Training-demand was made, is valid and registration pending.
  • Registered: Employee was registered on a training-session for this training.
  • Realized: Employee attended the training-session he was registered on.
Available options:
Invalid,
Requested,
Registered,
Realized
​
trainingId
integer<int32>

Identifier of the training.

​
hasSession
boolean

A session is planned for this training. Omit this parameter in order to retrieve all training demands, whether a session is planned or not.

​
ownerDepartmentId
integer<int32>[]

Only retrieve training-demands for employeesthat currently belong to one of the liste of departments IDs.

Required range: x >= 0
​
ownerEstablishmentId
integer<int32>[]

Only retrieve training-demands for employeesthat currently have a work-contract with one of the listed establishment IDs.

Required range: x >= 0
​
priorizationLevel
integer<int32>[]

Only retrieve training-demands that were given one of the listed priority levels.

Required array length: 1 - 5 elements
Required range: 0 <= x <= 4
​
limit
integer
default:20

Pagination: number of items per page.

Required range: 0 <= x <= 100
​
page

Page to retrieve. Either the page index or the page cursor .

Required range: x >= 0
​
fields.root
enum<string>[]

Include the total number of items across all pages, as well as pointers to the previous and next pages.

Available options:
prev,
next,
count
​
sort
enum<string>[]

Sort items by one of their property. Syntax is:

<sort>                  ::= '-|+'? <property> ( ',' <property> )*
<property>              ::= <strictString> ( '.' <strictString> )*
<strictString>          ::= ( <char> | <digit> | '_' | '-' )+
Available options:
prioritization.level,
-prioritization.level,
createdAt,
-createdAt
Example:
["-prioritization.level"]

Response

OK

​
count
integer<int32> | null

Total number of items across all pages. You need to include ?fields.root=count to your request to retrieve this.

Required range: x >= 0
​
prev
string | null

Cursor to the previous page. You need to include ?fields.root=prev in order to retrieve this.

​
next
string | null

Cursor to the next page. You need to include ?fields.root=next in order to retrieve this.

​
items
The training-demand resource · object[]