[Index]
View to automate manual on-boarding steps by using the Voss GUI Automation capability.
Model ref.: view/WebDriverCucmFeatureServiceStopStart
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": {
"gui_cucm_bkey": {
"target": "/api/data/GuiCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"title": "CUCM GUI Connection",
"type": "string",
"target_model_type": "data/GuiCucm",
"choices": []
},
"cucm_server_role": {
"default": "CUCM--CUCM Voice/Video",
"required": true,
"type": "string",
"title": "CUCM server role"
},
"service_operation": {
"description": "Service Operation Stop or Start.",
"title": "Service Operation",
"required": true,
"choices": [
{
"value": "stop",
"title": "stop"
},
{
"value": "start",
"title": "start"
}
],
"type": "string"
},
"Cisco_CallManager": {
"type": "boolean",
"title": "Cisco CallManager"
},
"Cisco_Unified_Mobile_Voice_Access_Service": {
"type": "boolean",
"title": "Cisco Unified Mobile Voice Access Service"
},
"Cisco_IP_Voice_Media_Streaming_App": {
"type": "boolean",
"title": "Cisco IP Voice Media Streaming App"
},
"Cisco_CTIManager": {
"type": "boolean",
"title": "Cisco CTIManager"
},
"Cisco_Extension_Mobility": {
"type": "boolean",
"title": "Cisco Extension Mobility"
},
"Cisco_Extended_Functions": {
"type": "boolean",
"title": "Cisco Extended Functions"
},
"Cisco_DHCP_Monitor_Service": {
"type": "boolean",
"title": "Cisco DHCP Monitor Service"
},
"Cisco_Intercluster_Lookup_Service": {
"type": "boolean",
"title": "Cisco Intercluster Lookup Service"
},
"Cisco_Location_Bandwidth_Manager": {
"type": "boolean",
"title": "Cisco Location Bandwidth Manager"
},
"Cisco_Directory_Number_Alias_Sync": {
"type": "boolean",
"title": "Cisco Directory Number Alias Sync"
},
"Cisco_Directory_Number_Alias_Lookup": {
"type": "boolean",
"title": "Cisco Directory Number Alias Lookup"
},
"Cisco_Dialed_Number_Analyzer_Server": {
"type": "boolean",
"title": "Cisco Dialed Number Analyzer Server"
},
"Cisco_Dialed_Number_Analyzer": {
"type": "boolean",
"title": "Cisco Dialed Number Analyzer"
},
"Cisco_Tftp": {
"type": "boolean",
"title": "Cisco Tftp"
},
"Cisco_IP_Manager_Assistant": {
"type": "boolean",
"title": "Cisco IP Manager Assistant"
},
"Cisco_WebDialer_Web_Service": {
"type": "boolean",
"title": "Cisco WebDialer Web Service"
},
"Self_Provisioning_IVR": {
"type": "boolean",
"title": "Self Provisioning IVR"
},
"Cisco_SOAP_-_CDRonDemand_Service": {
"type": "boolean",
"title": "Cisco SOAP - CDRonDemand Service"
},
"Cisco_CAR_Web_Service": {
"type": "boolean",
"title": "Cisco CAR Web Service"
},
"Cisco_Bulk_Provisioning_Service": {
"type": "boolean",
"title": "Cisco Bulk Provisioning Service"
},
"Cisco_AXL_Web_Service": {
"type": "boolean",
"title": "Cisco AXL Web Service"
},
"Cisco_UXL_Web_Service": {
"type": "boolean",
"title": "Cisco UXL Web Service"
},
"Cisco_TAPS_Service": {
"type": "boolean",
"title": "Cisco TAPS Service"
},
"Cisco_Serviceability_Reporter": {
"type": "boolean",
"title": "Cisco Serviceability Reporter"
},
"Cisco_CallManager_SNMP_Service": {
"type": "boolean",
"title": "Cisco CallManager SNMP Service"
},
"Cisco_CTL_Provider": {
"type": "boolean",
"title": "Cisco CTL Provider"
},
"Cisco_Certificate_Authority_Proxy_Function": {
"type": "boolean",
"title": "Cisco Certificate Authority Proxy Function"
},
"Cisco_DirSync": {
"type": "boolean",
"title": "Cisco DirSync"
},
"Cisco_Wireless_Controller_Synchronization_Service": {
"type": "boolean",
"title": "Cisco Wireless Controller Synchronization Service"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/WebDriverCucmFeatureServiceStopStart/add/ |
|
The GUI Add form of view/WebDriverCucmFeatureServiceStopStart 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/WebDriverCucmFeatureServiceStopStart | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/WebDriverCucmFeatureServiceStopStart | POST | /api/view/WebDriverCucmFeatureServiceStopStart/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/view/WebDriverCucmFeatureServiceStopStart/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/WebDriverCucmFeatureServiceStopStart/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/WebDriverCucmFeatureServiceStopStart/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/WebDriverCucmFeatureServiceStopStart/ |
|
The view/WebDriverCucmFeatureServiceStopStart schema and all instances as JSON. |
(The list will return 0 to 3 view/WebDriverCucmFeatureServiceStopStart instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/WebDriverCucmFeatureServiceStopStart/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/WebDriverCucmFeatureServiceStopStart",
"summary_attrs": [
{
"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": []
},
"model_specific_actions": [
"add"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/WebDriverCucmFeatureServiceStopStart/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/WebDriverCucmFeatureServiceStopStart. | GET | /api/view/WebDriverCucmFeatureServiceStopStart/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/WebDriverCucmFeatureServiceStopStart as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/WebDriverCucmFeatureServiceStopStart/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/WebDriverCucmFeatureServiceStopStart/[pkid] | hierarchy=[hierarchy] | The view/WebDriverCucmFeatureServiceStopStart instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/WebDriverCucmFeatureServiceStopStart/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/WebDriverCucmFeatureServiceStopStart. |