Webex · Schema

UserScheduleRecurrenceObject

Recurrence definition for a user's schedule event.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
recurForEver boolean Flag to indicate if event will recur forever.
recurEndDate string End date of recurrence.
recurEndOccurrence integer Number of occurrences after which the event will stop recurring.
recurDaily object Specifies the number of days between the start of each recurrence and is not allowed with `recurWeekly`.
recurWeekly object
View JSON Schema on GitHub

JSON Schema

webex-userschedulerecurrenceobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserScheduleRecurrenceObject",
  "title": "UserScheduleRecurrenceObject",
  "type": "object",
  "description": "Recurrence definition for a user's schedule event.",
  "example": {
    "recurForEver": true,
    "recurEndDate": "2020-03-31",
    "recurDaily": {
      "recurInterval": 1
    },
    "recurWeekly": {
      "sunday": false,
      "monday": true,
      "tuesday": false,
      "wednesday": true,
      "thursday": false,
      "friday": true,
      "saturday": false
    }
  },
  "properties": {
    "recurForEver": {
      "type": "boolean",
      "example": true,
      "description": "Flag to indicate if event will recur forever."
    },
    "recurEndDate": {
      "type": "string",
      "example": "2021-11-30",
      "description": "End date of recurrence."
    },
    "recurEndOccurrence": {
      "type": "integer",
      "example": 2,
      "description": "Number of occurrences after which the event will stop recurring."
    },
    "recurDaily": {
      "type": "object",
      "example": {
        "recurInterval": 1
      },
      "required": [
        "recurInterval"
      ],
      "properties": {
        "recurInterval": {
          "type": "number",
          "example": 1,
          "description": "Recurring interval in days. The number of days after the start when an event will repeat.  Repetitions cannot overlap."
        }
      },
      "description": "Specifies the number of days between the start of each recurrence and is not allowed with `recurWeekly`."
    },
    "recurWeekly": {
      "$ref": "#/components/schemas/RecurWeeklyObject"
    }
  }
}