[Index]

Model: relation/WebexSchedules

Webex Schedules

Full HTML Help

A Webex Schedule is associated with an existing Webex Location.

Existing Webex schedules from the Webex Control Hub are synced to the Webex location when running the default data sync - see the model list here: Webex App.

Note

To add a Webex Schedule at a hierarchy, a Webex Location must be available at the hierarchy. A message: "No Webex Location Found At This Hierarchy" will show in the Webex Location Name field when it is not available.

Refer to Webex Bulk Actions for details on the bulk add, delete or update of Webex schedules at more than one Webex location.

Add a Schedule

  1. From the Webex Schedules menu, navigate to the Webex Location hierarchy and click Add.

    The Webex Location Name (read-only) shows on the Details form.

  2. Provide a Name and Type for the schedule.

  3. According to the selected Type, add one or more calendar Events, along with the event calendar from the calendar picker and associated recurrence details.

    Note

    You can set up a recurrence end date for Webex schedule events, or select Recur Forever. If you've selected a recurrence end date and you select Recur Forever, only the Recur Forever setting is configured for the Webex schedule. The end date, even if present, is thus disabled.

  4. Click Save and inspect the entry in the Webex Schedules list view.

Modify a Schedule

Only Event entries can be modified on existing schedules.

Note

The schedule Name, Location Name and Type can't be updated. If you need to change any of these values, delete the schedule, then add a new schedule with updated values.

Delete a schedule

You can delete Webex schedules from the list view or from the detail view.

Webex Schedules

Model Details: relation/WebexSchedules

Title Description Details
ID A unique identifier for the schedule.
  • Field Name: id
  • Type: String
Name A unique name for the schedule.
  • Field Name: name
  • Type: String
Webex Location Name The name of the location of the schedule.
  • Field Name: locationName
  • Type: String
Location ID A unique identifier for the location of the schedule.
  • Field Name: locationId
  • Type: String
Type A unique identifier for the schedule.
  • Field Name: scheduleType
  • Type: String
  • Choices: ["businessHours", "holidays"]
New Business Key Generated new key field used to pass to get_by_value in driver.
  • Field Name: schedules_id
  • Type: String
Events List of schedule events.
  • Field Name: events.[n]
  • Type: Array
Name A unique name for the event.
  • Field Name: events.[n].name
  • Type: String
ID Unique identifier for the event.
  • Field Name: events.[n].id
  • Type: String
Start Date Start Date of Event.
  • Field Name: events.[n].startDate
  • Type: String
End Date End Date of Event.
  • Field Name: events.[n].endDate
  • Type: String
Start Time Start time of event.
  • Field Name: events.[n].startTime
  • Type: String
End Time End time of event.
  • Field Name: events.[n].endTime
  • Type: String
All Day Enabled An indication of whether given event is an all-day event or not.
  • Field Name: events.[n].allDayEnabled
  • Type: Boolean
Recurrence Recurrence definition.
  • Field Name: recurrence
  • Type: Object
Recur Forever Flag to indicate if event will recur forever.
  • Field Name: events.[n].recurrence.recurForEver
  • Type: Boolean
Recurrence End Date End date of recurrence.
  • Field Name: events.[n].recurrence.recurEndDate
  • Type: String
Recur Weekly Recurrence weekly definition.
  • Field Name: recurWeekly
  • Type: Object
Sunday Frequency of occurrence in weeks and select the day - Sunday
  • Field Name: events.[n].recurrence.recurWeekly.sunday
  • Type: Boolean
Monday Frequency of occurrence in weeks and select the day - Monday
  • Field Name: events.[n].recurrence.recurWeekly.monday
  • Type: Boolean
Tuesday Frequency of occurrence in weeks and select the day - Tuesday
  • Field Name: events.[n].recurrence.recurWeekly.tuesday
  • Type: Boolean
Wednesday Frequency of occurrence in weeks and select the day - Wednesday
  • Field Name: events.[n].recurrence.recurWeekly.wednesday
  • Type: Boolean
Thursday Frequency of occurrence in weeks and select the day - Thursday
  • Field Name: events.[n].recurrence.recurWeekly.thursday
  • Type: Boolean
Friday Frequency of occurrence in weeks and select the day - Friday
  • Field Name: events.[n].recurrence.recurWeekly.friday
  • Type: Boolean
Saturday Frequency of occurrence in weeks and select the day - Saturday
  • Field Name: events.[n].recurrence.recurWeekly.saturday
  • Type: Boolean
Recur Yearly by Date Recur definition yearly by date.
  • Field Name: recurYearlyByDate
  • Type: Object
Day Of Month Schedule the event on a specific day of the month
  • Field Name: events.[n].recurrence.recurYearlyByDate.dayOfMonth
  • Type: Integer
Month Schedule the event on a specific month of the year.
  • Field Name: events.[n].recurrence.recurYearlyByDate.month
  • Type: String
  • Choices: ["JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
Recur Yearly by Day Recur definition yearly by day.
  • Field Name: recurYearlyByDay
  • Type: Object
Day Schedule the event on a specific day.
  • Field Name: events.[n].recurrence.recurYearlyByDay.day
  • Type: String
  • Choices: ["SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"]
Week Schedule the event on a specific week.
  • Field Name: events.[n].recurrence.recurYearlyByDay.week
  • Type: String
  • Choices: ["FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
Month Schedule the event on a specific month.
  • Field Name: events.[n].recurrence.recurYearlyByDay.month
  • Type: String
  • Choices: ["JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
No Instance
  • Field Name: NoInstance.[n]
  • Type: Array
Name *
  • Field Name: NoInstance.[n].name
  • Type: String
  • MaxLength: 1024