[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": {
"id": {
"title": "ID",
"description": "A unique identifier for the schedule.",
"type": "string"
},
"name": {
"title": "Name",
"description": "A unique name for the schedule.",
"type": "string"
},
"locationName": {
"title": "Webex Location Name",
"description": "The name of the location of the schedule.",
"type": "string"
},
"locationId": {
"title": "Location ID",
"description": "A unique identifier for the location of the schedule.",
"type": "string"
},
"scheduleType": {
"title": "Type",
"description": "A unique identifier for the schedule.",
"type": "string",
"choices": [
{
"value": "businessHours",
"title": "businessHours"
},
{
"value": "holidays",
"title": "holidays"
}
]
},
"schedules_id": {
"title": "New Business Key",
"description": "Generated new key field used to pass to get_by_value in driver.",
"type": "string"
},
"events": {
"description": "List of schedule events.",
"title": "Events",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "A unique name for the event."
},
"id": {
"type": "string",
"title": "ID",
"description": "Unique identifier for the event."
},
"startDate": {
"type": "string",
"title": "Start Date",
"description": "Start Date of Event."
},
"endDate": {
"type": "string",
"title": "End Date",
"description": "End Date of Event."
},
"startTime": {
"type": "string",
"title": "Start Time",
"description": "Start time of event."
},
"endTime": {
"type": "string",
"title": "End Time",
"description": "End time of event."
},
"allDayEnabled": {
"type": "boolean",
"title": "All Day Enabled",
"description": "An indication of whether given event is an all-day event or not."
},
"recurrence": {
"title": "Recurrence",
"description": "Recurrence definition.",
"required": false,
"type": "object",
"properties": {
"recurForEver": {
"type": "boolean",
"title": "Recur Forever",
"description": "Flag to indicate if event will recur forever."
},
"recurEndDate": {
"type": "string",
"title": "Recurrence End Date",
"description": "End date of recurrence."
},
"recurWeekly": {
"title": "Recur Weekly",
"description": "Recurrence weekly definition.",
"required": false,
"type": "object",
"properties": {
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Frequency of occurrence in weeks and select the day - Sunday"
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Frequency of occurrence in weeks and select the day - Monday"
},
"tuesday": {
"type": "boolean",
"title": "Tuesday",
"description": "Frequency of occurrence in weeks and select the day - Tuesday"
},
"wednesday": {
"type": "boolean",
"title": "Wednesday",
"description": "Frequency of occurrence in weeks and select the day - Wednesday"
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Frequency of occurrence in weeks and select the day - Thursday"
},
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Frequency of occurrence in weeks and select the day - Friday"
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Frequency of occurrence in weeks and select the day - Saturday"
}
}
},
"recurYearlyByDate": {
"title": "Recur Yearly by Date",
"description": "Recur definition yearly by date.",
"required": false,
"type": "object",
"properties": {
"dayOfMonth": {
"type": "integer",
"title": "Day Of Month",
"description": "Schedule the event on a specific day of the month"
},
"month": {
"type": "string",
"title": "Month",
"description": "Schedule the event on a specific month of the year.",
"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"
}
]
}
}
},
"recurYearlyByDay": {
"title": "Recur Yearly by Day",
"description": "Recur definition yearly by day.",
"required": false,
"type": "object",
"properties": {
"day": {
"type": "string",
"title": "Day",
"description": "Schedule the event on a specific 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"
}
]
},
"week": {
"type": "string",
"title": "Week",
"description": "Schedule the event on a specific week.",
"choices": [
{
"value": "FIRST",
"title": "FIRST"
},
{
"value": "SECOND",
"title": "SECOND"
},
{
"value": "THIRD",
"title": "THIRD"
},
{
"value": "FOURTH",
"title": "FOURTH"
},
{
"value": "LAST",
"title": "LAST"
}
]
},
"month": {
"type": "string",
"title": "Month",
"description": "Schedule the event on a specific 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"
}
]
}
}
}
}
}
}
}
},
"NoInstance": {
"title": "No Instance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
}
}
}
}
| 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 |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/WebexSchedules/+tag/ |
|
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/WebexSchedules/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"update",
"tag",
"remove",
"field_display_policy",
"add",
"help",
"configuration_template",
"list",
"export",
"get",
"bulk_update",
"clone",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/WebexSchedules",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/WebexSchedules/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"tag",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"clone",
"export_bulkload_template"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/WebexSchedules/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/WebexSchedules/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/WebexSchedules/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/WebexSchedules/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/WebexSchedules/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"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]. |