[Index]
View to automate manual on-boarding steps by using the Voss GUI Automation capability.
Model ref.: view/WebDriverCucmNetworkServiceStopStart
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": {
"Cisco_Log_Partition_Monitoring_Tool": {
"type": "boolean",
"title": "Cisco Log Partition Monitoring Tool"
},
"cucm_server_role": {
"default": "CUCM--CUCM Voice/Video",
"required": true,
"type": "string",
"title": "CUCM server role"
},
"Cisco_E911": {
"type": "boolean",
"title": "Cisco E911"
},
"Cisco_Audit_Event_Service": {
"type": "boolean",
"title": "Cisco Audit Event Service"
},
"Cisco_Tomcat_Stats_Servlet": {
"type": "boolean",
"title": "Cisco Tomcat Stats Servlet"
},
"Cisco_DRF_Master": {
"type": "boolean",
"title": "Cisco DRF Master"
},
"Cisco_CDP_Agent": {
"type": "boolean",
"title": "Cisco CDP Agent"
},
"Cisco_AMC_Service": {
"type": "boolean",
"title": "Cisco AMC Service"
},
"Cisco_Certificate_Change_Notification": {
"type": "boolean",
"title": "Cisco Certificate Change Notification"
},
"Cisco_CallManager_Admin": {
"type": "boolean",
"title": "Cisco CallManager Admin"
},
"Cisco_CDR_Repository_Manager": {
"type": "boolean",
"title": "Cisco CDR Repository Manager"
},
"Cisco_Trace_Collection_Servlet": {
"type": "boolean",
"title": "Cisco Trace Collection Servlet"
},
"service_operation": {
"choices": [
{
"value": "stop",
"title": "stop"
},
{
"value": "start",
"title": "start"
}
],
"required": true,
"type": "string",
"description": "Service Operation Stop or Start.",
"title": "Service Operation"
},
"Cisco_Tomcat": {
"type": "boolean",
"title": "Cisco Tomcat"
},
"Cisco_User_Data_Services": {
"type": "boolean",
"title": "Cisco User Data Services"
},
"Cisco_Certificate_Expiry_Monitor": {
"type": "boolean",
"title": "Cisco Certificate Expiry Monitor"
},
"SNMP_Master_Agent": {
"type": "boolean",
"title": "SNMP Master Agent"
},
"Cisco_DRF_Local": {
"type": "boolean",
"title": "Cisco DRF Local"
},
"Cisco_CDR_Agent": {
"type": "boolean",
"title": "Cisco CDR Agent"
},
"SOAP_-Real-Time_Service_APIs": {
"type": "boolean",
"title": "SOAP -Real-Time Service APIs"
},
"Cisco_Trace_Collection_Service": {
"type": "boolean",
"title": "Cisco Trace Collection Service"
},
"Cisco_CDP": {
"type": "boolean",
"title": "Cisco CDP"
},
"Cisco_Push_Notification_Service": {
"type": "boolean",
"title": "Cisco Push Notification Service"
},
"Cisco_Database_Layer_Monitor": {
"type": "boolean",
"title": "Cisco Database Layer Monitor"
},
"Cisco_License_Manager": {
"type": "boolean",
"title": "Cisco License Manager"
},
"Cisco_CallManager_Serviceability": {
"type": "boolean",
"title": "Cisco CallManager Serviceability"
},
"Cisco_ELM_Client_Service": {
"type": "boolean",
"title": "Cisco ELM Client Service"
},
"Cisco_Management_Agent_Service": {
"type": "boolean",
"title": "Cisco Management Agent Service"
},
"System_Application_Agent": {
"type": "boolean",
"title": "System Application Agent"
},
"Cisco_CallManager_Serviceability_RTMT": {
"type": "boolean",
"title": "Cisco CallManager Serviceability RTMT"
},
"SOAP_-Log_Collection_APIs": {
"type": "boolean",
"title": "SOAP -Log Collection APIs"
},
"Host_Resources_Agent": {
"type": "boolean",
"title": "Host Resources Agent"
},
"Cisco_CAR_Scheduler": {
"type": "boolean",
"title": "Cisco CAR Scheduler"
},
"Cisco_RIS_Data_Collector": {
"type": "boolean",
"title": "Cisco RIS Data Collector"
},
"Cisco_CAR_DB": {
"type": "boolean",
"title": "Cisco CAR DB"
},
"Cisco_Change_Credential_Application": {
"type": "boolean",
"title": "Cisco Change Credential Application"
},
"Platform_Administrative_Web_Service": {
"type": "boolean",
"title": "Platform Administrative Web Service"
},
"Cisco_Syslog_Agent": {
"type": "boolean",
"title": "Cisco Syslog Agent"
},
"Cisco_SOAP_-_CallRecord_Service": {
"type": "boolean",
"title": "Cisco SOAP - CallRecord Service"
},
"MIB2_Agent": {
"type": "boolean",
"title": "MIB2 Agent"
},
"gui_cucm_bkey": {
"target": "/api/data/GuiCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "CUCM GUI Connection",
"required": true,
"choices": [],
"target_model_type": "data/GuiCucm",
"type": "string"
},
"SOAP_-_Diagnostic_Portal_Database_Service": {
"type": "boolean",
"title": "SOAP - Diagnostic Portal Database Service"
},
"Cisco_RTMT_Reporter_Servlet": {
"type": "boolean",
"title": "Cisco RTMT Reporter Servlet"
},
"A_Cisco_DB_Replicator": {
"type": "boolean",
"title": "A Cisco DB Replicator"
},
"Cisco_Extension_Mobility_Application": {
"type": "boolean",
"title": "Cisco Extension Mobility Application"
},
"SOAP_-Performance_Monitoring_APIs": {
"type": "boolean",
"title": "SOAP -Performance Monitoring APIs"
},
"Cisco_Trust_Verification_Service": {
"type": "boolean",
"title": "Cisco Trust Verification Service"
},
"A_Cisco_DB": {
"type": "boolean",
"title": "A Cisco DB"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/WebDriverCucmNetworkServiceStopStart/add/ |
|
The GUI Add form of view/WebDriverCucmNetworkServiceStopStart 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/WebDriverCucmNetworkServiceStopStart/ | 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/WebDriverCucmNetworkServiceStopStart | POST | /api/view/WebDriverCucmNetworkServiceStopStart/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/WebDriverCucmNetworkServiceStopStart/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/WebDriverCucmNetworkServiceStopStart/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/WebDriverCucmNetworkServiceStopStart/ |
|
The view/WebDriverCucmNetworkServiceStopStart schema and all instances as JSON. |
(The list will return 0 to 3 view/WebDriverCucmNetworkServiceStopStart instances)
{
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/view/WebDriverCucmNetworkServiceStopStart/?skip=0&limit=3&order_by=None&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": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/WebDriverCucmNetworkServiceStopStart/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/WebDriverCucmNetworkServiceStopStart",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/WebDriverCucmNetworkServiceStopStart. | GET | /api/view/WebDriverCucmNetworkServiceStopStart/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/WebDriverCucmNetworkServiceStopStart as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/WebDriverCucmNetworkServiceStopStart/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/WebDriverCucmNetworkServiceStopStart/[pkid]/ | hierarchy=[hierarchy] | The view/WebDriverCucmNetworkServiceStopStart instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/WebDriverCucmNetworkServiceStopStart/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/WebDriverCucmNetworkServiceStopStart. |