[Index]
View to automate manual on-boarding steps by using the Voss GUI Automation capability.
Model ref.: view/WebDriverImpNetworkServiceStopStart
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"
},
"Cisco_Audit_Event_Service": {
"type": "boolean",
"title": "Cisco Audit Event Service"
},
"Cisco_Login_Datastore": {
"type": "boolean",
"title": "Cisco Login Datastore"
},
"Cisco_Presence_Datastore": {
"type": "boolean",
"title": "Cisco Presence Datastore"
},
"Cisco_Tomcat_Stats_Servlet": {
"type": "boolean",
"title": "Cisco Tomcat Stats Servlet"
},
"Cisco_RCC_Device_Selection_Service": {
"type": "boolean",
"title": "Cisco RCC Device Selection Service"
},
"Cisco_AMC_Service": {
"type": "boolean",
"title": "Cisco AMC Service"
},
"Cisco_Server_Recovery_Manager": {
"type": "boolean",
"title": "Cisco Server Recovery Manager"
},
"Cisco_Route_Datastore": {
"type": "boolean",
"title": "Cisco Route Datastore"
},
"Cisco_Trace_Collection_Servlet": {
"type": "boolean",
"title": "Cisco Trace Collection Servlet"
},
"imp_server_role": {
"default": "IMP--CUCM IM and Presence",
"required": true,
"type": "string",
"title": "IMP server role"
},
"gui_imp_bkey": {
"target": "/api/data/GuiImp/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "IMP GUI Connection",
"required": true,
"choices": [],
"target_model_type": "data/GuiImp",
"type": "string"
},
"Cisco_Tomcat": {
"type": "boolean",
"title": "Cisco Tomcat"
},
"Cisco_Intercluster_Sync_Agent": {
"type": "boolean",
"title": "Cisco Intercluster Sync Agent"
},
"Cisco_SIP_Registration_Datastore": {
"type": "boolean",
"title": "Cisco SIP Registration Datastore"
},
"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"
},
"SOAP_-Real-Time_Service_APIs": {
"type": "boolean",
"title": "SOAP -Real-Time Service APIs"
},
"Cisco_Trace_Collection_Service": {
"type": "boolean",
"title": "Cisco Trace Collection Service"
},
"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_CDP": {
"type": "boolean",
"title": "Cisco CDP"
},
"Cisco_IM_and_Presence_Admin": {
"type": "boolean",
"title": "Cisco IM and Presence Admin"
},
"Cisco_Database_Layer_Monitor": {
"type": "boolean",
"title": "Cisco Database Layer Monitor"
},
"Cisco_XCP_Router": {
"type": "boolean",
"title": "Cisco XCP Router"
},
"Cisco_CallManager_Serviceability": {
"type": "boolean",
"title": "Cisco CallManager Serviceability"
},
"Cisco_CDP_Agent": {
"type": "boolean",
"title": "Cisco CDP Agent"
},
"Cisco_Config_Agent": {
"type": "boolean",
"title": "Cisco Config Agent"
},
"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_RIS_Data_Collector": {
"type": "boolean",
"title": "Cisco RIS Data Collector"
},
"Cisco_XCP_Config_Manager": {
"type": "boolean",
"title": "Cisco XCP Config Manager"
},
"Cisco_OAM_Agent": {
"type": "boolean",
"title": "Cisco OAM Agent"
},
"Cisco_IM_and_Presence_Data_Monitor": {
"type": "boolean",
"title": "Cisco IM and Presence Data Monitor"
},
"Cisco_Client_Profile_Agent": {
"type": "boolean",
"title": "Cisco Client Profile Agent"
},
"Platform_Administrative_Web_Service": {
"type": "boolean",
"title": "Platform Administrative Web Service"
},
"Cisco_Sync_Agent": {
"type": "boolean",
"title": "Cisco Sync Agent"
},
"Cisco_Syslog_Agent": {
"type": "boolean",
"title": "Cisco Syslog Agent"
},
"MIB2_Agent": {
"type": "boolean",
"title": "MIB2 Agent"
},
"Cisco_RTMT_Reporter_Servlet": {
"type": "boolean",
"title": "Cisco RTMT Reporter Servlet"
},
"A_Cisco_DB_Replicator": {
"type": "boolean",
"title": "A Cisco DB Replicator"
},
"SOAP_-Performance_Monitoring_APIs": {
"type": "boolean",
"title": "SOAP -Performance Monitoring APIs"
},
"A_Cisco_DB": {
"type": "boolean",
"title": "A Cisco DB"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/WebDriverImpNetworkServiceStopStart/add/ |
|
The GUI Add form of view/WebDriverImpNetworkServiceStopStart 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/WebDriverImpNetworkServiceStopStart/ | 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/WebDriverImpNetworkServiceStopStart | POST | /api/view/WebDriverImpNetworkServiceStopStart/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/WebDriverImpNetworkServiceStopStart/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/WebDriverImpNetworkServiceStopStart/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/WebDriverImpNetworkServiceStopStart/ |
|
The view/WebDriverImpNetworkServiceStopStart schema and all instances as JSON. |
(The list will return 0 to 3 view/WebDriverImpNetworkServiceStopStart 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/WebDriverImpNetworkServiceStopStart/?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/WebDriverImpNetworkServiceStopStart/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/WebDriverImpNetworkServiceStopStart/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/WebDriverImpNetworkServiceStopStart",
"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/WebDriverImpNetworkServiceStopStart. | GET | /api/view/WebDriverImpNetworkServiceStopStart/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/WebDriverImpNetworkServiceStopStart as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/WebDriverImpNetworkServiceStopStart/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/WebDriverImpNetworkServiceStopStart/[pkid]/ | hierarchy=[hierarchy] | The view/WebDriverImpNetworkServiceStopStart instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/WebDriverImpNetworkServiceStopStart/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/WebDriverImpNetworkServiceStopStart. |