Absences
Create absence
post /api/http/absences Create an absence for a given profile (member).
Rights, that may be checked: Edit absences
|
Request arguments | object with fields : member : string ( Required )
reason : string ( Required )
description : string ( Required )
location : string ( Nullable and Optional )
since : string (format: full-date) ( Required )
till : string (format: full-date) ( Required )
available : boolean ( Optional , defaults to false )
icon : string ( Required )
customFieldValues : array of CustomFieldValue ( Nullable and Optional , defaults to null )
| |
Get all absences
get /api/http/absences Search absences. Parameters are applied as 'AND' filters.
Rights, that may be checked: View absences
|
Request arguments | $skip : string (Query) ( Nullable and Optional , defaults to null ) | $top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 ) | member : string (Query) ( Nullable and Optional , defaults to null ) | members : array of string (Query) ( Nullable and Optional , defaults to null ) | location : string (Query) ( Nullable and Optional , defaults to null ) | team : string (Query) ( Nullable and Optional , defaults to null ) | since : string (format: full-date) (Query) ( Nullable and Optional , defaults to null ) | till : string (format: full-date) (Query) ( Nullable and Optional , defaults to null ) | viewMode : AbsenceListMode (Query) ( Optional , defaults to "All" ) | reason : string (Query) ( Nullable and Optional , defaults to null ) | Response | object with fields : next : string ( Required )
totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )
data : array of AbsenceRecord ( Required )
| |
Approve absence
post /api/http/absences/{id}/approve Approve/unapprove an existing absence. Setting approve to true will approve the absence, false will remove the approval.
Rights, that may be checked: Approve absences
|
Request arguments | id : string (Path) ( Required ) | | object with fields : | |
Get all absences by member
get /api/http/absences/member:{member} Get absences for a given profile id.
Rights, that may be checked: View absences
|
Request arguments | member : string (Path) ( Required ) | |
Get absence
get /api/http/absences/{id} Get an absence.
Rights, that may be checked: View absences
|
Request arguments | id : string (Path) ( Required ) | |
Update absence
patch /api/http/absences/{id} Create an existing absence. Optional parameters will be ignored when not specified, and updated otherwise.
Rights, that may be checked: Edit absences
|
Request arguments | id : string (Path) ( Required ) | object with fields : member : string ( Nullable and Optional , defaults to null )
reason : string ( Nullable and Optional , defaults to null )
description : string ( Nullable and Optional , defaults to null )
location : string ( Nullable and Optional )
since : string (format: full-date) ( Nullable and Optional , defaults to null )
till : string (format: full-date) ( Nullable and Optional , defaults to null )
available : boolean ( Required )
icon : string ( Nullable and Optional , defaults to null )
customFieldValues : array of CustomFieldValue ( Nullable and Optional , defaults to null )
| |
Delete absence
delete /api/http/absences/{id} Archive/restore an existing absence. Setting delete to true will archive the absence, false will restore it.
Rights, that may be checked: Edit absences , Create or edit past absences
|
Request arguments | id : string (Path) ( Required ) | delete : boolean (Query) ( Optional , defaults to true ) | |
Delete absence approval
delete /api/http/absences/{id}/delete-approval Delete approval for a given absence.
Rights, that may be checked: Approve absences
|
Request arguments | id : string (Path) ( Required ) | |
Create absence reason
post /api/http/absences/absence-reasons Create a new absence reason.
Rights, that may be checked: Edit absence types
|
Request arguments | object with fields : name : string ( Required )
description : string ( Required )
defaultAvailability : boolean ( Required )
approvalRequired : boolean ( Required )
icon : string ( Nullable and Optional , defaults to null )
| |
Get all absence reasons
get /api/http/absences/absence-reasons Get available absence reasons.
Rights, that may be checked: View absence types
|
Request arguments | withArchived : boolean (Query) ( Optional , defaults to false ) | |
Create absence reason
post /api/http/absences/absence-reasons/{id} Update an existing absence reason.
Rights, that may be checked: Edit absence types
|
Request arguments | id : string (Path) ( Required ) | object with fields : name : string ( Required )
description : string ( Required )
defaultAvailability : boolean ( Required )
approvalRequired : boolean ( Required )
icon : string ( Nullable and Optional , defaults to null )
| |
Get absence reason
get /api/http/absences/absence-reasons/{id} Get an absence reason.
Rights, that may be checked: View absence types
|
Request arguments | id : string (Path) ( Required ) | |
Delete absence reason
delete /api/http/absences/absence-reasons/{id} Archive/restore an existing absence reason. Setting delete to true will archive the absence reason, false will restore it.
Rights, that may be checked: Edit absence types
|
Request arguments | id : string (Path) ( Required ) | delete : boolean (Query) ( Optional , defaults to true ) | |
Last modified: 18 November 2020