plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Absence

Absence

An absence: the period an employee was away from work, booked for them by HR.

View as Markdown
Summary view
AbsenceList, 10 fields. What a list returns by default.
Detail view
Absence, 10 fields. The default for a single read and for every write.
Read with
api:read:absencesandabsences::manage
Write with
api:write:absencesandabsences::manage

An absence with no end is still running and reaches through now everywhere it is read, so planning capacity and reporting both keep counting it until someone closes it. The free-text note absences once carried was purged as health data and is not exposed here.

Used by

GETList absences/absencesAbsenceList
POSTBook an absence/absencesAbsence
GETRead an absence/absences/{absence}Absence
PATCHUpdate an absence/absences/{absence}Absence

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

user_idinteger

The employee this absence is for. Writing it requires the absences::manage permission.

userRef or UserSummary

The employee the absence is for. Renders as an {"id": N} reference unless expanded, and stays a reference when the employee has since been deleted.

manager_idinteger or null

Manager who filed or approved the absence, or null when none was recorded. The foreign key nulls on delete, so removing the manager leaves the absence behind unattributed.

managerRef or UserSummary or null

The manager who filed or approved the absence; absent when none was recorded.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

When the absence begins. RFC 3339 UTC.

endtimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When the absence ends, or null while it is still running. An ongoing absence reaches through now everywhere it is read (planning capacity and reporting both count it), and that reach is uncapped, so an absence nobody closed keeps consuming capacity. RFC 3339 UTC.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

Variants

AbsenceList 10 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

AbsenceSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: user_id, user, manager_id, manager, created_at, updated_at, links

AbsenceLinks 1 field

The links object on this resource.

Keys: self