API Reference for view/WebexBulkActions

A view to make changes to different kinds of models within Webex

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

For [auth_token]:

The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
Model schemas show that the auth_token parameter is still supported.

[pkid] is the ID of the resource instance. Refer to the List reference below.

[filename] refers to a file

GET http://[host-proxy]/api/view/WebexBulkActions/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "model": {
               "title": "Model",
               "type": "string",
               "default": "schedules",
               "choices": [
                    {
                         "value": "schedules",
                         "title": "schedules"
                    },
                    {
                         "value": "devices",
                         "title": "devices"
                    }
               ]
          },
          "deviceType": {
               "title": "Device Type",
               "type": "string",
               "required": false
          },
          "operation": {
               "title": "Operation",
               "type": "string",
               "required": true,
               "default": "add"
          },
          "referenceSchedule": {
               "title": "Reference Schedule",
               "type": "string"
          },
          "scheduleCft": {
               "title": "Configuration Template",
               "description": "This template will allows an admin to make structural naming changes to the schedules built at Webex locations. ",
               "type": "string"
          },
          "deviceCft": {
               "title": "Configuration Template",
               "description": "This template will allows an admin to make bulk configuraton changes to chosen devices",
               "type": "string"
          },
          "deleteSchedules": {
               "title": "Delete Schedules",
               "type": "array",
               "items": {
                    "type": "string"
               }
          },
          "targetSchedules": {
               "title": "Target Schedules",
               "type": "array",
               "items": {
                    "type": "string"
               }
          },
          "targetLocations": {
               "title": "Target Webex Locations",
               "type": "array",
               "items": {
                    "type": "string"
               }
          },
          "targetDevices": {
               "title": "Target Webex Devices",
               "type": "array",
               "items": {
                    "type": "string"
               }
          }
     },
     "schema_version": "0.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/WebexBulkActions/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/WebexBulkActions 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/view/WebexBulkActions	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

API Reference for view/WebexBulkActions

GET http://[host-proxy]/api/view/WebexBulkActions/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Instance API Reference