[Index]
Webex Schedules
Model ref.: relation/WebexSchedules
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "name": { "type": "string", "description": "A unique name for the schedule.", "title": "Name" }, "events": { "items": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Start Date of Event.", "title": "Start Date" }, "endDate": { "type": "string", "description": "End Date of Event.", "title": "End Date" }, "name": { "type": "string", "description": "A unique name for the event.", "title": "Name" }, "allDayEnabled": { "type": "boolean", "description": "An indication of whether given event is an all-day event or not.", "title": "All Day Enabled" }, "recurrence": { "properties": { "recurForEver": { "type": "boolean", "description": "Flag to indicate if event will recur forever.", "title": "Recur Forever" }, "recurYearlyByDay": { "properties": { "week": { "choices": [ { "value": "FIRST", "title": "FIRST" }, { "value": "SECOND", "title": "SECOND" }, { "value": "THIRD", "title": "THIRD" }, { "value": "FOURTH", "title": "FOURTH" }, { "value": "LAST", "title": "LAST" } ], "type": "string", "description": "Schedule the event on a specific week.", "title": "Week" }, "day": { "choices": [ { "value": "SUNDAY", "title": "SUNDAY" }, { "value": "MONDAY", "title": "MONDAY" }, { "value": "TUESDAY", "title": "TUESDAY" }, { "value": "WEDNESDAY", "title": "WEDNESDAY" }, { "value": "THURSDAY", "title": "THURSDAY" }, { "value": "FRIDAY", "title": "FRIDAY" }, { "value": "SATURDAY", "title": "SATURDAY" } ], "type": "string", "description": "Schedule the event on a specific day.", "title": "Day" }, "month": { "choices": [ { "value": "JANUARY", "title": "JANUARY" }, { "value": "FEBRUARY", "title": "FEBRUARY" }, { "value": "MARCH", "title": "MARCH" }, { "value": "APRIL", "title": "APRIL" }, { "value": "MAY", "title": "MAY" }, { "value": "JUNE", "title": "JUNE" }, { "value": "JULY", "title": "JULY" }, { "value": "AUGUST", "title": "AUGUST" }, { "value": "SEPTEMBER", "title": "SEPTEMBER" }, { "value": "OCTOBER", "title": "OCTOBER" }, { "value": "NOVEMBER", "title": "NOVEMBER" }, { "value": "DECEMBER", "title": "DECEMBER" } ], "type": "string", "description": "Schedule the event on a specific month.", "title": "Month" } }, "required": false, "type": "object", "description": "Recur definition yearly by day.", "title": "Recur Yearly by Day" }, "recurEndDate": { "type": "string", "description": "End date of recurrence.", "title": "Recurrence End Date" }, "recurYearlyByDate": { "properties": { "month": { "choices": [ { "value": "JANUARY", "title": "JANUARY" }, { "value": "FEBRUARY", "title": "FEBRUARY" }, { "value": "MARCH", "title": "MARCH" }, { "value": "APRIL", "title": "APRIL" }, { "value": "MAY", "title": "MAY" }, { "value": "JUNE", "title": "JUNE" }, { "value": "JULY", "title": "JULY" }, { "value": "AUGUST", "title": "AUGUST" }, { "value": "SEPTEMBER", "title": "SEPTEMBER" }, { "value": "OCTOBER", "title": "OCTOBER" }, { "value": "NOVEMBER", "title": "NOVEMBER" }, { "value": "DECEMBER", "title": "DECEMBER" } ], "type": "string", "description": "Schedule the event on a specific month of the year.", "title": "Month" }, "dayOfMonth": { "type": "integer", "description": "Schedule the event on a specific day of the month", "title": "Day Of Month" } }, "required": false, "type": "object", "description": "Recur definition yearly by date.", "title": "Recur Yearly by Date" }, "recurWeekly": { "properties": { "monday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Monday", "title": "Monday" }, "tuesday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Tuesday", "title": "Tuesday" }, "friday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Friday", "title": "Friday" }, "wednesday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Wednesday", "title": "Wednesday" }, "thursday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Thursday", "title": "Thursday" }, "sunday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Sunday", "title": "Sunday" }, "saturday": { "type": "boolean", "description": "Frequency of occurrence in weeks and select the day - Saturday", "title": "Saturday" } }, "required": false, "type": "object", "description": "Recurrence weekly definition.", "title": "Recur Weekly" } }, "required": false, "type": "object", "description": "Recurrence definition.", "title": "Recurrence" }, "startTime": { "type": "string", "description": "Start time of event.", "title": "Start Time" }, "endTime": { "type": "string", "description": "End time of event.", "title": "End Time" }, "id": { "type": "string", "description": "Unique identifier for the event.", "title": "ID" } } }, "type": "array", "description": "List of schedule events.", "title": "Events" }, "locationName": { "type": "string", "description": "The name of the location of the schedule.", "title": "Webex Location Name" }, "locationId": { "type": "string", "description": "A unique identifier for the location of the schedule.", "title": "Location ID" }, "schedules_id": { "type": "string", "description": "Generated new key field used to pass to get_by_value in driver.", "title": "New Business Key" }, "scheduleType": { "choices": [ { "value": "businessHours", "title": "businessHours" }, { "value": "holidays", "title": "holidays" } ], "type": "string", "description": "A unique identifier for the schedule.", "title": "Type" }, "id": { "type": "string", "description": "A unique identifier for the schedule.", "title": "ID" }, "NoInstance": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "title": "No Instance" } } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/WebexSchedules/add/ |
|
The GUI Add form of relation/WebexSchedules as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/relation/WebexSchedules | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/WebexSchedules/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexSchedules/[pkid1]", "/api/relation/WebexSchedules/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexSchedules/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/relation/WebexSchedules/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/WebexSchedules/ |
|
The relation/WebexSchedules schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexSchedules instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "list", "update", "remove", "bulk_update", "add", "tag", "export", "export_bulkload_template" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/WebexSchedules/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": null, "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/WebexSchedules/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/WebexSchedules/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/WebexSchedules/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/relation/WebexSchedules/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/relation/WebexSchedules/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/WebexSchedules/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } } ], "model_type": "relation/WebexSchedules", "model_specific_actions": [ "configuration_template", "get", "clone", "list", "update", "remove", "add", "tag", "export", "export_bulkload_template" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "scheduleType", "title": "Type" }, { "name": "locationName", "title": "Webex Location Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/WebexSchedules/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/WebexSchedules/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/WebexSchedules/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/WebexSchedules/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/relation/WebexSchedules/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/WebexSchedules/[pkid] | hierarchy=[hierarchy] | The relation/WebexSchedules instance with [pkid]. |