ScheduleSetMemberMap Objects
ScheduleSetMemberMap objects provide the linkage between a ScheduleSet and a Schedule that is included
or excluded from it (via a boolean called Exclude). There will be one ScheduleSetMemberMap object for
each Schedule that is included in or excluded from a ScheduleSet.
A ScheduleSetMemberMap abstracts the linkage between a ScheduleSet and a Schedule since neither object
has an explicit linkage or ownership relationship of the other. One reason for this is that several ScheduleSets
might reference the same Schedule (a Holiday Schedule for example). This differs from the relationship
between a Schedule and a ScheduleDetail, since a ScheduleDetail has an explicit link to a Schedule, the
Schedule essentially owns the ScheduleDetail, and no other Schedule may use another Schedule's ScheduleDetail
object.
Schedule Example
For example, let's model a weekday schedule with the lunch hour blocked out as unavailable every work day,
and with various holidays blocked out as well. Using the objects discussed previously, this schedule might
be composed like so:
• First, we create a top-level ScheduleSet called WeekdaySet. WeekdaySet includes the WeekdaySchedule
and excludes the HolidaySchedule (2 Schedule objects).
• After we create these 2 Schedule objects, we create 2 ScheduleSetMemberMap objects for WeekdaySet
- one to include WeekdaySchedule and one to exclude HolidaySchedule.
• Then, we create 2 ScheduleDetail objects for WeekdaySchedule - one active from 8AM to 12PM Mon-Fri,
and the other active from 1PM to 5PM Mon-Fri.
• Finally, we create various ScheduleDetails objects for HolidaySchedule, one per holiday. For example,
we might create a July4ScheduleDetail with start and end dates both set to July 4 2010, and a
WinterBreakScheduleDetail with a start date of Dec 23 2010 and an end date of Jan 3 2011.
To see how to create this schedule via CUPI, see the Schedule Example page.
CUPI for Schedules
The previously described database objects are accessible to the administrator via CUPI. The following sections
list the URIs to access these resources along with the data contained within them.
ScheduleSets in CUPI
ScheduleSets are top-level resources in CUPI, with a base URI of +/vmrest/schedulesets+.
A ScheduleSet object has the following fields:
Notes
Default
Field
Type
Field Name
NA
None
GUID
ObjectId
The unique identifier of the tenant to which the schedulesets
belong. This field is reflected in the response only if the
schedulesets belong to a particular tenant.
String
(36)
Read
Only
TenantObjectId
NA
None
String
(64)
DisplayName
One of the Owners must be non-NULL
Null
GUID
OwnerLocationObjectId
Cisco Unity Connection Provisioning Interface (CUPI) API
714
Cisco Unity Connection Provisioning Interface (CUPI) API for Schedules
ScheduleSetMemberMap Objects