[Index]

API Reference for relation/WebDriverCucServer

CUC connection relation

Model ref.: relation/WebDriverCucServer

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "username": {
               "required": false, 
               "type": "string", 
               "description": "Username to use with specified authentication method.", 
               "title": "Username"
          }, 
          "name": {
               "required": true, 
               "type": "string", 
               "description": "Name for this instance of generic driver connection details.", 
               "title": "Name"
          }, 
          "driver_parameters": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "name": {
                              "required": true, 
                              "type": "string", 
                              "description": "Name of additional driver parameter.", 
                              "title": "Name"
                         }, 
                         "value": {
                              "required": true, 
                              "type": "string", 
                              "description": "Value of additional driver parameter.", 
                              "title": "Value"
                         }
                    }
               }, 
               "type": "array", 
               "description": "Additional parameters for the driver", 
               "title": "Driver Parameters"
          }, 
          "test_connection_uri": {
               "type": "string", 
               "description": "URI to use when testing connection to external service, e.g. https://service.domain/api/health, {{ driver_parameters.host_base }}/status", 
               "title": "Test Connection URI"
          }, 
          "default_request_headers": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "name": {
                              "required": true, 
                              "type": "string", 
                              "description": "Name of HTTP request header, e.g. Accept.", 
                              "title": "Name"
                         }, 
                         "value": {
                              "required": true, 
                              "type": "string", 
                              "description": "Value of HTTP request header, e.g. text/plain.", 
                              "title": "Value"
                         }
                    }
               }, 
               "type": "array", 
               "description": "Default HTTP request headers to send with all device model API operation requests. Defaults specified here will be overriden by request headers specified on individual device model API operation definitions.", 
               "title": "Default Request Headers"
          }, 
          "default_response_handlers": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "type": {
                              "choices": [
                                   {
                                        "value": "backoff_retry", 
                                        "title": "Backoff & Retry"
                                   }, 
                                   {
                                        "value": "failure_duplicate", 
                                        "title": "Failure - Duplicate"
                                   }, 
                                   {
                                        "value": "invalid_session", 
                                        "title": "Invalid Session"
                                   }
                              ], 
                              "required": true, 
                              "type": "string", 
                              "description": "Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.", 
                              "title": "Type"
                         }, 
                         "condition": {
                              "required": true, 
                              "type": "string", 
                              "description": "Jinja template which if evaluation results in a value of True will cause the specified handler type to be executed, e.g. {{ status_code == 429 }}.", 
                              "title": "Condition"
                         }
                    }
               }, 
               "type": "array", 
               "description": "Default handlers to execute on all API operation responses. Only those response handlers' which condition evaluates to True are executed.", 
               "title": "Default Response Handlers"
          }, 
          "token": {
               "is_password": true, 
               "description": "Token to use with specified authentication method.", 
               "title": "Token", 
               "required": false, 
               "store_encrypted": true, 
               "type": "string"
          }, 
          "version": {
               "pattern": "^[0-9]+?(\\.[0-9]+?)+?$", 
               "required": true, 
               "type": "string", 
               "description": "Version of models to use.", 
               "title": "Version"
          }, 
          "session_based_auth_request": {
               "properties": {
                    "login_uri": {
                         "type": "string", 
                         "description": "URI for the API Login request.", 
                         "title": "Login URI"
                    }, 
                    "session_headers": {
                         "items": {
                              "type": "object", 
                              "properties": {
                                   "session_header_name": {
                                        "type": "string", 
                                        "description": "Name of session request header, e.g. Cookie.", 
                                        "title": "Header Name"
                                   }, 
                                   "session_header_value": {
                                        "type": "string", 
                                        "description": "Value of session request header, e.g. session=12345.", 
                                        "title": "Header Value"
                                   }
                              }
                         }, 
                         "type": "array", 
                         "description": "Session headers to include for all requests.", 
                         "title": "Headers"
                    }, 
                    "request_template": {
                         "type": "string", 
                         "description": "A request template that will be used for POST requests.", 
                         "title": "Request Template for POST requests"
                    }, 
                    "session_expire_minutes": {
                         "type": "integer", 
                         "description": "The amount of time a session is valid specifiec in minutes.", 
                         "title": "Session Expire Time (min)"
                    }, 
                    "login_http_method": {
                         "default": "POST", 
                         "choices": [
                              {
                                   "value": "GET", 
                                   "title": "GET"
                              }, 
                              {
                                   "value": "POST", 
                                   "title": "POST"
                              }
                         ], 
                         "type": "string", 
                         "description": "HTTP method for API login request.", 
                         "title": "Login HTTP Method"
                    }, 
                    "use_request_body": {
                         "type": "boolean", 
                         "description": "Use a request body to send login credentials.", 
                         "title": "Use Request Body on Login"
                    }
               }, 
               "type": "object", 
               "description": "Describes the API request required to obtain a valid auth token.", 
               "title": "Session Based Auth Request"
          }, 
          "password": {
               "is_password": true, 
               "description": "Password to use with specified authentication method.", 
               "title": "Password", 
               "required": false, 
               "store_encrypted": true, 
               "type": "string"
          }, 
          "auth_method": {
               "choices": [
                    {
                         "value": "BASIC", 
                         "title": "HTTP Basic Authentication"
                    }, 
                    {
                         "value": "OAUTH", 
                         "title": "OAuth(OApen Authorization)"
                    }, 
                    {
                         "value": "SESSION", 
                         "title": "Session Based Authentication"
                    }, 
                    {
                         "value": "OCIP", 
                         "title": "Broadsoft OCIP socket based authentication protocol"
                    }
               ], 
               "required": true, 
               "type": "string", 
               "description": "Type of authentication to use when interfacing to the external service.", 
               "title": "Authentication Method"
          }, 
          "NoInstance": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "name": {
                              "is_password": false, 
                              "title": "Name", 
                              "required": true, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }
                    }
               }, 
               "type": "array", 
               "maxItems": 1, 
               "title": "No Instance"
          }, 
          "description": {
               "required": true, 
               "type": "string", 
               "description": "Description for this instance of generic driver connection details.", 
               "title": "Description"
          }
     }
}

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

Response is a transaction pkid for the create action.

Use the GET call to

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/WebDriverCucServer/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/WebDriverCucServer/[pkid1]", "/api/relation/WebDriverCucServer/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/WebDriverCucServer
```
GET http://[host-proxy]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=relation/WebDriverCucServer	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/WebDriverCucServer/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=relation/WebDriverCucServer	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/WebDriverCucServer/[pkid1]", "/api/relation/WebDriverCucServer/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebDriverCucServer; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/WebDriverCucServer/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/WebDriverCucServer/[pkid1]", "/api/relation/WebDriverCucServer/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of relation/WebDriverCucServer and the JSON format can be used to import instances of relation/WebDriverCucServer.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/WebDriverCucServer:

 GET http://[host-proxy]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for relation/WebDriverCucServer	POST	/api/relation/WebDriverCucServer/export_bulkload_template/	hierarchy=[hierarchy] modeltype=relation/WebDriverCucServer	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/relation/WebDriverCucServer/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/relation/WebDriverCucServer/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/relation/WebDriverCucServer/	hierarchy=[hierarchy] format=json schema=true	The relation/WebDriverCucServer schema and all instances as JSON.

(The list will return 0 to 3 relation/WebDriverCucServer instances)

GET http://[host]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "field_display_policy", 
          "configuration_template", 
          "help", 
          "get", 
          "clone", 
          "move", 
          "list", 
          "update", 
          "remove", 
          "bulk_update", 
          "add", 
          "tag", 
          "export", 
          "export_bulkload_template"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/relation/WebDriverCucServer/?skip=0&limit=3&order_by=name&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": ""
                    }
               ], 
               "self": [
                    {
                         "pkid": null, 
                         "href": "/api/relation/WebDriverCucServer/None/"
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/relation/WebDriverCucServer/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/WebDriverCucServer", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/relation/WebDriverCucServer/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/relation/WebDriverCucServer/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "tag": {
                         "title": "Tag", 
                         "support_async": true, 
                         "method": "PATCH", 
                         "href": "/api/relation/WebDriverCucServer/+tag/?hierarchy=[hierarchy]", 
                         "class": "tag", 
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/relation/WebDriverCucServer/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/relation/WebDriverCucServer/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/relation/WebDriverCucServer/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "relation/WebDriverCucServer", 
          "model_specific_actions": [
               "field_display_policy", 
               "configuration_template", 
               "help", 
               "get", 
               "clone", 
               "move", 
               "list", 
               "update", 
               "remove", 
               "add", 
               "tag", 
               "export", 
               "export_bulkload_template"
          ], 
          "summary_attrs": [
               {
                    "name": "name", 
                    "title": "Name"
               }, 
               {
                    "name": "description", 
                    "title": "Host"
               }, 
               {
                    "name": "version", 
                    "title": "Version"
               }, 
               {
                    "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 relation/WebDriverCucServer.	GET	/api/relation/WebDriverCucServer/help	hierarchy=[hierarchy]	On-line help of Model ref.: relation/WebDriverCucServer as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/relation/WebDriverCucServer/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/relation/WebDriverCucServer/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/relation/WebDriverCucServer/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for relation/WebDriverCucServer

GET http://[host-proxy]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=relation/WebDriverCucServer	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebDriverCucServer; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/WebDriverCucServer/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of relation/WebDriverCucServer and the JSON format can be used to import instances of relation/WebDriverCucServer.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/relation/WebDriverCucServer/[pkid]/+tag/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/relation/WebDriverCucServer/[pkid]/	hierarchy=[hierarchy]	The relation/WebDriverCucServer instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/relation/WebDriverCucServer/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for relation/WebDriverCucServer.

API Reference for relation/WebDriverCucServer

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

Get the Add form

Create

Bulk Delete

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/relation/WebDriverCucServer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Tag

Get

Help