GET
/
v2
/
training-demands
List training-demands
curl --request GET \
  --url https://{host}/v2/training-demands \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": 410,
      "training": {
        "id": 15,
        "title": "Angular (advanced)",
        "level": "Middle"
      },
      "provider": {
        "id": 9,
        "name": "Google",
        "url": "https://google.com"
      },
      "author": {
        "id": 416,
        "firstName": "John",
        "lastName": "Doe",
        "type": "Owner"
      },
      "owner": {
        "id": 416,
        "firstName": "John",
        "lastName": "Doe",
        "establishmentId": 1,
        "departmentId": 12,
        "picture": {
          "id": "a41832b8-9734-493c-9185-b5ccf50ec42b",
          "href": "https://example.ilucca.net/getFile.ashx?id=a41832b8-9734-493c-9185-b5ccf50ec42b"
        },
        "manager": {
          "id": 521,
          "firstName": "Matt",
          "lastName": "Bawss"
        }
      },
      "plan": {
        "id": 2,
        "name": "2024 Plan",
        "startOn": "2024-01-01"
      },
      "createdAt": "2023-01-01T09:34:43.6529455+00:00",
      "session": {
        "id": 169,
        "durationInHours": 21,
        "location": {
          "isOnSite": false,
          "isRemote": false,
          "address": ""
        }
      },
      "prioritization": {
        "id": 2,
        "name": "High",
        "level": "High",
        "lastModifiedAt": "2023-04-19T08:17:29.4241633+00:00"
      },
      "state": "Requested",
      "status": "PendingRegistration"
    }
  ],
  "count": 234,
  "prev": "~SGlnaA|LYJ77Z9Zqz|q6",
  "next": "!SGlnaA|A1kVrwDKrz|th"
}

Headers

​
Authorization
string
required

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

Query Parameters

​
ownerId
integer

Identifier of the employee that should attend this training session.

Required range: x >= 1
​
sessionId
integer

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
​
trainingId
integer

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[]

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

​
ownerEstablishmentId
integer[]

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

​
priorizationLevel
integer[]

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

Required array length: 1 - 5 elements
​
limit
integer
default:20

Pagination: number of items per page. @TODO: check maximum value

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

Page to retrieve. Either the page index <int> or the page cursor <string>.

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.

​
sort
enum<string>[]

Sort items by one of their property. Syntax is:

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

Response

OK

​
items
The training-demand resource · object[]
​
count
integer | 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.