Planner
Look up unavailability sets
Returns the configured unavailability schedules and series, with their rules, exceptions and drafts. It does not return the individual unavailabilities: for that there is «Look up unavailabilities».
At a glance
Link to this section: At a glance| Property | Value |
|---|---|
| Domain | availability |
| Group in the editor | Planner › Calendar |
| Runs as | The owner of the workflow, with their permissions |
| Permission | View access to at least one of: Management, Vehicles, Spaces. Administrators always pass; a module outside the plan blocks everyone. |
| Destructive | Not declared |
Inputs
resourceTypeenum<string>Required
Available options: staff, vehicle, space
resourceIdstring
statusenum<string>
Available options: draft, published, archived, superseded
Outputs
schedulesobject[]
Show child attributesHide child attributes
schedules.idstring
schedules.resourceTypeenum<string>
Available options: staff, vehicle, space
schedules.sourceKeystring
schedules.namestring
schedules.revisionnumber
schedules.baseRevisionnumber
schedules.statusstring
schedules.operationstring
schedules.effectiveFromstring
schedules.expiresAtstring
schedules.createdAtstring
schedules.publishedAtstring | null
schedules.previewjson
schedules.resultjson | null
schedules.rulesobject[]
Show child attributesHide child attributes
schedules.rules.externalIdstring
schedules.rules.lineageExternalIdstring | null
schedules.rules.resourceIdstring
schedules.rules.frequencyenum<string>
Available options: once, weekly
schedules.rules.startDatestring
schedules.rules.endDatestring
schedules.rules.daysOfWeekstring[] | null
schedules.rules.startTimestring | null
schedules.rules.endTimestring | null
schedules.rules.allDayboolean | null
schedules.rules.endNextDayboolean | null
schedules.rules.timezonestring
schedules.rules.absenceTypeenum<string> | null
Available options: vacation, sick, personal, training, maintenance, inspection, repair, reserved, academic, event, closure, other
schedules.rules.reasonstring | null
schedules.rules.exceptionsobject[] | null
schedules.rules.idstring
Was this page helpful?