Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
WorkCycleExceptions

List WorkCycleExceptions.

Retrieve a paginated list of WorkCycleExceptions that satisfy the given query filters.

get/api/v3/workcycleExceptions

Query parameters

fieldsstring[]

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",
  "ownerId",
  "isAm",
  "startsAt",
  "duration",
  "unit",
  "createdAt",
  "modifiedAt",
  "deletedAt"
]
idinteger[]

Retrieve WorkCycleExceptions that match one of the given IDs (comma separated list).

ownerIdinteger[]

Only retrieve WorkCycleExceptions that apply to one of the given employees, identified by their ID (comma separated list of int).

isAmboolean

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.
startsAtstring
Example:between,2023-01-01,2023-12-31

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}.
deletedAt'notequal,null' | 'null'
  • null (default): do no include deleted WorkCycleExceptions.
  • notequal,null: only retrieve deleted WorkCycleExceptions.
  • no param: retrieve both deleted and non-deleted WorkCycleExceptions.
unit0 | 1 | 2

A (work) event can be defined in one of 3 units. The unit must conform to the one defined by the applicable work-cycle of the given employee for the given date.

  • 0: "days", the event duration is defined as a fraction of a (work) day.
  • 1: "hours", the event duration is defined as a number of hours.
  • 2: "time", the event duration is defined as a number of hours, at the time component of the startsAt property indicates the starting time.

Only retrieve WorkCycleExceptions whose unit match one of the given.

pagingstring

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

orderBystring[]

Sort items by ascending or descending property value. Syntax is: {propertyName},{direction} where direction can either be asc (ascending) or desc (descending).

Response

OK