Get Schedule Availability - Hyland Automate Modeling - Current - Current - Ready - Content Innovation Cloud - external

Hyland Automate Modeling
Platform
Content Innovation Cloud
Product
Hyland Automate Modeling
Release
Current
License

The getScheduleAvailability action retrieves a users availability information for a specific period of time.

The input parameters to get the schedule availability are:

Parameter Type Required Description
startDate DateTime Required Start Date / Time of the event
endDate DateTime Required End Date / Time of the event
timeZone String Optional Time zone (for example, Pacific Standard Time). The timeZone property can be set to any of the time zones supported by Microsoft Windows as well as the additional time zones supported by the calendar API. Set to GMT Standard Time by default.
scheduleAddress Array Required Email address of a user, group, or room
availabilityViewInterval Integer Required Defines the granularity, in minutes, used to represent the users availability. Default value: 60

The output parameters to get the schedule availability are:

Parameter Type Required Description
availabilityView String Required Merged view of availability for the specific period of time. The merged view is a string that consists of time slots covering that day, with each time slot using the following convention:
  • n0: Free
  • n1: Tentative
  • n2: Busy
  • n3: Out of office
  • n4: Working elsewhere
availability String Required Single value that represents a global availability status for the required period:
  • 0: User is free during entire interval
  • 1: All the existing slots in the required period are either free or tentative (at least one of them is tentative)
  • 2: All the existing slots in the required period are either free or tentative or busy (at least one of them is busy)
  • 3: All the existing slots in the required period are either free or tentative or busy or out of the office (at least one of them is out of the office)
  • 4: All the existing slots in the required period are either free or tentative or busy or out of the office or working elsewhere (at least one of them is working elsewhere).
scheduleItems JSON Required List of objects containing each of the events in the user`s calendar
workingHours JSON Required Indicates the days of the week and time intervals when the user can be available.