GET
/
v1
/
realized-trainings

Query Parameters

ownerId
integer

Only retrieve realized-trainings that involve a given employee ID.

Required range: x > 1
sessionId
integer

Only retrieve realized-trainings related to the given session ID.

Required range: x > 1
hasAttended
boolean

Return the realized-trainings the owner actually attended (true) or those the owner was absent (false).

sessionEndOnAfter
string

Returns the realized-trainings that have a sessionEndDate after (non inclusive) this date

sort
enum<string>[]

Sort items by one of their property. "+<prop>" == "<prop>" => ascending "prop" value "-<prop>" => descending "prop" value Syntax is:

<sort>                  ::= '-|+'? <property> ( ',' <property> )*
<property>              ::= <strictString> ( '.' <strictString> )*
<strictString>          ::= ( <char> | <digit> | '_' | '-' )+
Available options:
id,
+id,
-id,
createdAt,
+createdAt,
-createdAt
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
page

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

Required range: x > 0
limit
integer
default: 20

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

Required range: 0 < x < 100

Response

200 - application/json
items
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.

Was this page helpful?

The realized-training resource