List WorkCycleExceptions.
Retrieve a paginated list of WorkCycleExceptions that satisfy the given query filters.
Query Parameters
List the properties you want included in the response.
Example: ?fields=id,ownerId,isAm,startsAt,duration,unit,createdAt,modifiedAt,deletedAt,collection.count
The collection.count
field indicates the total number of items across all pages.
id
, name
, url
, ownerId
, owner.id
, owner.name
, owner.url
, owner.firstName
, owner.lastName
, isAm
, unit
, startsAt
, endsAt
, durationInMinutes
, duration
, authorId
, createdAt
, modifierId
, modifiedAt
, deletedById
, deletedAt
, collection.count
Retrieve WorkCycleExceptions that match one of the given IDs (comma separated list).
Only retrieve WorkCycleExceptions that apply to one of the given employees, identified by their ID (comma separated list of int).
Filter on the isAm
property.
true
: the workcycleException applies to the first half-day.false
: the workcycleException applies to the second half-day. Omit this query parameter in order to retrieve all workcycleExceptions, whether they apply to the first or the second half-day.
Only retrieve items that match the given date condition.
?startsAt=between,{date1},{date2}
: items that intersect the {date1}- {date2} period.?startsAt=since,{date}
: items that occur after (non-strict) the given {date}.?startsAt=until,{date}
: items that occur before (non-strict) the given {date}.
null
(default): do no include deleted WorkCycleExceptions.notequal,null
: only retrieve deleted WorkCycleExceptions.- no param: retrieve both deleted and non-deleted WorkCycleExceptions.
notequal,null
, null
Only retrieve WorkCycleExceptions whose unit match one of the given.
0
, 1
, 2
Syntax: {index},{pageSize}
Index is the position of the first item to retrieve.
PageSize is the number of items per page.
Note: Page size cannot exceed 1,000.
For example, to retrieve the first 100 items:
?paging=0,100
, then to retrieve the 100 next:
?paging:100,100
Sort items by ascending or descending property value.
Syntax is: {propertyName},{direction}
where direction
can
either be asc
(ascending) or desc
(descending).
id,asc
, id,desc
, startsAt,asc
, startsAt,desc
Response
Was this page helpful?