[Index]
IMP connection relation
Model ref.: relation/WebDriverImpServer
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": {
"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"
},
"secure_driver_parameters": {
"items": {
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of additional secure driver parameter.",
"title": "Name"
},
"value": {
"is_password": true,
"description": "Value of additional secure driver parameter.",
"title": "Value",
"required": true,
"store_encrypted": true,
"type": "string"
}
}
},
"type": "array",
"description": "Additional secure parameters for the driver",
"title": "Secure Driver Parameters"
},
"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"
},
"common_actions": {
"items": {
"type": "object",
"properties": {
"pre_request_calls": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of API calls to make before making this request",
"title": "Pre-request Calls"
},
"target": {
"description": "Target of this operation",
"title": "Target",
"default": "HTTP",
"required": false,
"choices": [
{
"value": "HTTP",
"title": "HTTP"
},
{
"value": "Browser",
"title": "Browser"
},
{
"value": "SOAP",
"title": "SOAP"
},
{
"value": "Socket",
"title": "Socket"
},
{
"value": "winrm",
"title": "winrm"
}
],
"type": "string"
},
"variables": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Context variable name. This will appear in the context as 'variables.<name>'",
"title": "Name"
},
"value": {
"type": "string",
"description": "Value of this variable. This field supports Macros",
"title": "Value"
}
}
},
"type": "array",
"description": "List of context variables availble to template rendering (supports Macros)",
"title": "Variables"
},
"uri": {
"type": "string",
"description": "URI for the API request",
"title": "URI"
},
"response_format": {
"description": "Response format",
"title": "Response Format",
"default": "JSON",
"required": false,
"choices": [
{
"value": "JSON",
"title": "JSON"
},
{
"value": "XML",
"title": "XML"
}
],
"type": "string"
},
"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": "HTTP request headers to send with API operation request. Takes precedence over default request headers specified on related Connection Parameters Type instance.",
"title": "Request Headers"
},
"post_request_calls": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of API calls to make after making this request",
"title": "Post-request Calls"
},
"http_method": {
"default": "get",
"choices": [
{
"value": "GET",
"title": "GET"
},
{
"value": "POST",
"title": "POST"
},
{
"value": "PATCH",
"title": "PATCH"
},
{
"value": "PUT",
"title": "PUT"
},
{
"value": "DELETE",
"title": "DELETE"
}
],
"type": "string",
"description": "HTTP method for API request",
"title": "HTTP Method"
},
"request_template": {
"type": "string",
"description": "Jinja template for API request. Maps system schema to external application schema.",
"title": "Request Template"
},
"response_code_template": {
"type": "string",
"description": "Jinja template for mapping API endpoint specific error/status response",
"title": "Response Code Template"
},
"action": {
"required": true,
"type": "string",
"description": "Name of the device model operation for e.g. add",
"title": "Action"
},
"response_template": {
"type": "string",
"description": "Jinja template for API response. Maps external application schema to system schema.",
"title": "Response Template"
},
"request_format": {
"description": "Request format",
"title": "Request Format",
"default": "JSON",
"required": false,
"choices": [
{
"value": "JSON",
"title": "JSON"
},
{
"value": "XML",
"title": "XML"
},
{
"value": "string",
"title": "string"
}
],
"type": "string"
},
"response_handlers": {
"items": {
"type": "object",
"properties": {
"type": {
"choices": [
{
"value": "backoff_retry",
"title": "Backoff & Retry"
},
{
"value": "failure_duplicate",
"title": "Failure - Duplicate"
}
],
"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": "Handlers to execute on API responses. Only those response handlers' which condition evaluate to True are executed.",
"title": "Response Handlers"
}
}
},
"type": "array",
"description": "Actions used identically by many device models",
"title": "Common Actions"
},
"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 initial Login request. This is a jinja template with custom functions and driver parameter context available.",
"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. This is a jinja template with custom functions and response body, header & cookie context available.",
"title": "Header Value"
}
}
},
"type": "array",
"description": "Session headers to capture from the login response and include for requests after the initial login.",
"title": "Headers To Cache"
},
"request_template": {
"type": "string",
"description": "Request body for the initial login request if the method is POST. This is a jinja template with custom functions and driver parameter context available.",
"title": "Login Request Body Template (POST)"
},
"session_expire_minutes": {
"type": "integer",
"description": "The amount of time a session is valid specified 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 initial login request.",
"title": "Login HTTP Method"
},
"login_request_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. This is a jinja template with custom functions and driver parameter context available.",
"title": "Header Value"
}
}
},
"type": "array",
"description": "Request headers for the initial login request.",
"title": "Login Request Headers"
}
},
"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/WebDriverImpServer/add/ |
|
The GUI Add form of relation/WebDriverImpServer 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/WebDriverImpServer/ | hierarchy=[hierarchy] |
|
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/WebDriverImpServer/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebDriverImpServer/[pkid1]", "/api/relation/WebDriverImpServer/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebDriverImpServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/WebDriverImpServer |
|
{"hrefs": ["/api/relation/WebDriverImpServer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/WebDriverImpServer |
|
{"hrefs": ["/api/relation/WebDriverImpServer/[pkid1]", "/api/relation/WebDriverImpServer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebDriverImpServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebDriverImpServer/export/ |
|
{ "hrefs":["/api/relation/WebDriverImpServer/[pkid1]", "/api/relation/WebDriverImpServer/[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/WebDriverImpServer and the JSON format can be used to import instances of relation/WebDriverImpServer.
GET http://[host-proxy]/api/relation/WebDriverImpServer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebDriverImpServer | POST | /api/relation/WebDriverImpServer/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/WebDriverImpServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebDriverImpServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebDriverImpServer/ |
|
The relation/WebDriverImpServer schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebDriverImpServer instances)
{
"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/WebDriverImpServer/?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/WebDriverImpServer/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/WebDriverImpServer/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/WebDriverImpServer/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/WebDriverImpServer",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/WebDriverImpServer/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/WebDriverImpServer/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/WebDriverImpServer/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/WebDriverImpServer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/WebDriverImpServer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/WebDriverImpServer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/WebDriverImpServer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/WebDriverImpServer",
"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": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/WebDriverImpServer. | GET | /api/relation/WebDriverImpServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/WebDriverImpServer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/WebDriverImpServer/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebDriverImpServer/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/WebDriverImpServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/WebDriverImpServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/WebDriverImpServer | 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/WebDriverImpServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebDriverImpServer/[pkid]/export/ |
|
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/WebDriverImpServer and the JSON format can be used to import instances of relation/WebDriverImpServer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/WebDriverImpServer/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebDriverImpServer/[pkid]/ | hierarchy=[hierarchy] | The relation/WebDriverImpServer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/WebDriverImpServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/WebDriverImpServer. |