Webex · Schema

UserLocationScheduleEvent

Schedule Event configuration.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the schedule event.
name	string	Name for the event.
startDate	string	Start Date of Event.
endDate	string	End Date of Event.
startTime	string	Start time of event.
endTime	string	End time of event.
allDayEnabled	boolean	An indication of whether given event is an all-day event or not.
recurrence	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserLocationScheduleEvent",
  "title": "UserLocationScheduleEvent",
  "type": "object",
  "description": "Schedule Event configuration.",
  "required": [
    "id",
    "name",
    "startDate",
    "endDate",
    "allDayEnabled"
  ],
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG",
    "name": "Event1 Name",
    "startDate": "2023-02-06",
    "endDate": "2023-02-06",
    "allDayEnabled": true,
    "recurrence": {
      "recurForEver": true,
      "recurYearlyByDay": {
        "day": "MONDAY",
        "week": "FIRST",
        "month": "FEBRUARY"
      }
    }
  },
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RXOXVaR0Y1VTJOb1pXUjFiR1U",
      "description": "A unique identifier for the schedule event."
    },
    "name": {
      "type": "string",
      "example": "MondaySchedule",
      "description": "Name for the event."
    },
    "startDate": {
      "type": "string",
      "example": "2021-11-01",
      "description": "Start Date of Event."
    },
    "endDate": {
      "type": "string",
      "example": "2021-11-30",
      "description": "End Date of Event."
    },
    "startTime": {
      "type": "string",
      "example": "12:20",
      "description": "Start time of event."
    },
    "endTime": {
      "type": "string",
      "example": "14:20",
      "description": "End time of event."
    },
    "allDayEnabled": {
      "type": "boolean",
      "description": "An indication of whether given event is an all-day event or not."
    },
    "recurrence": {
      "$ref": "#/components/schemas/RecurrenceObject"
    }
  }
}