[Index]

Model: data/GuiCucm

Stores generic driver connection parameters for interfacing to an external service.

Model Details: data/GuiCucm

Title Description Details
Name * Name for this instance of generic driver connection details.
  • Field Name: name
  • Type: String
Description * Description for this instance of generic driver connection details.
  • Field Name: description
  • Type: String
Version * Version of models to use.
  • Field Name: version
  • Type: String
  • Pattern: ^[0-9]+?(\.[0-9]+?)+?$
Authentication Method * Type of authentication to use when interfacing to the external service.
  • Field Name: auth_method
  • Type: String
  • Choices: ["HTTP Basic Authentication", "OAuth(OApen Authorization)", "Session Based Authentication"]
Username Username to use with specified authentication method.
  • Field Name: username
  • Type: String
Password Password to use with specified authentication method.
  • Field Name: password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Token Token to use with specified authentication method.
  • Field Name: token
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Test Connection URI URI to use when testing connection to external service, e.g. https://service.domain/api/health, {{ driver_parameters.host_base }}/status
  • Field Name: test_connection_uri
  • Type: String
Driver Parameters Additional parameters for the driver
  • Field Name: driver_parameters.[n]
  • Type: Array
Name * Name of additional driver parameter.
  • Field Name: driver_parameters.[n].name
  • Type: String
Value * Value of additional driver parameter.
  • Field Name: driver_parameters.[n].value
  • Type: String
Secure Driver Parameters Additional secure parameters for the driver
  • Field Name: secure_driver_parameters.[n]
  • Type: Array
Name * Name of additional secure driver parameter.
  • Field Name: secure_driver_parameters.[n].name
  • Type: String
Value * Value of additional secure driver parameter.
  • Field Name: secure_driver_parameters.[n].value
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Default Request Headers 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.
  • Field Name: default_request_headers.[n]
  • Type: Array
Name * Name of HTTP request header, e.g. Accept.
  • Field Name: default_request_headers.[n].name
  • Type: String
Value * Value of HTTP request header, e.g. text/plain.
  • Field Name: default_request_headers.[n].value
  • Type: String
Default Response Handlers Default handlers to execute on all API operation responses. Only those response handlers' which condition evaluates to True are executed.
  • Field Name: default_response_handlers.[n]
  • Type: Array
Condition * 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 }}.
  • Field Name: default_response_handlers.[n].condition
  • Type: String
Type * Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.
  • Field Name: default_response_handlers.[n].type
  • Type: String
  • Choices: ["Backoff & Retry", "Failure - Duplicate", "Invalid Session"]
Session Based Auth Request Describes the API request required to obtain a valid auth token.
  • Field Name: session_based_auth_request
  • Type: Object
Login URI URI for the API Login request.
  • Field Name: session_based_auth_request.login_uri
  • Type: String
Login HTTP Method HTTP method for API login request. Default: POST
  • Field Name: session_based_auth_request.login_http_method
  • Type: String
  • Default: POST
  • Choices: ["GET", "POST"]
Login Request Headers Request headers for the initial login request.
  • Field Name: login_request_headers.[n]
  • Type: Array
Header Name Name of session request header, e.g. Cookie.
  • Field Name: session_based_auth_request.login_request_headers.[n].session_header_name
  • Type: String
Header Value Value of session request header, e.g. session=12345. This is a jinja template with custom functions and driver parameter context available.
  • Field Name: session_based_auth_request.login_request_headers.[n].session_header_value
  • Type: String
Request Template for POST requests A request template that will be used for POST requests.
  • Field Name: session_based_auth_request.request_template
  • Type: String
Session Expire Time (min) The amount of time a session is valid specifiec in minutes.
  • Field Name: session_based_auth_request.session_expire_minutes
  • Type: Integer
Headers Session headers to include for all requests.
  • Field Name: session_headers.[n]
  • Type: Array
Header Name Name of session request header, e.g. Cookie.
  • Field Name: session_based_auth_request.session_headers.[n].session_header_name
  • Type: String
Header Value Value of session request header, e.g. session=12345.
  • Field Name: session_based_auth_request.session_headers.[n].session_header_value
  • Type: String
Common Actions Actions used identically by many device models
  • Field Name: common_actions.[n]
  • Type: Array
Action * Name of the device model operation for e.g. add
  • Field Name: common_actions.[n].action
  • Type: String
URI URI for the API request
  • Field Name: common_actions.[n].uri
  • Type: String
Target Target of this operation Default: HTTP
  • Field Name: common_actions.[n].target
  • Type: String
  • Default: HTTP
  • Choices: ["HTTP", "Browser", "SOAP", "Socket", "winrm"]
Request Format Request format Default: JSON
  • Field Name: common_actions.[n].request_format
  • Type: String
  • Default: JSON
  • Choices: ["JSON", "XML", "string"]
Response Format Response format Default: JSON
  • Field Name: common_actions.[n].response_format
  • Type: String
  • Default: JSON
  • Choices: ["JSON", "XML"]
HTTP Method HTTP method for API request Default: get
  • Field Name: common_actions.[n].http_method
  • Type: String
  • Default: get
  • Choices: ["GET", "POST", "PATCH", "PUT", "DELETE"]
Response Code Template Jinja template for mapping API endpoint specific error/status response
  • Field Name: common_actions.[n].response_code_template
  • Type: String
Request Headers HTTP request headers to send with API operation request. Takes precedence over default request headers specified on related Connection Parameters Type instance.
  • Field Name: request_headers.[n]
  • Type: Array
Name * Name of HTTP request header, e.g. Accept.
  • Field Name: common_actions.[n].request_headers.[n].name
  • Type: String
Value * Value of HTTP request header, e.g. text/plain.
  • Field Name: common_actions.[n].request_headers.[n].value
  • Type: String
Response Handlers Handlers to execute on API responses. Only those response handlers' which condition evaluate to True are executed.
  • Field Name: response_handlers.[n]
  • Type: Array
Condition * 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 }}.
  • Field Name: common_actions.[n].response_handlers.[n].condition
  • Type: String
Type * Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.
  • Field Name: common_actions.[n].response_handlers.[n].type
  • Type: String
  • Choices: ["Backoff & Retry", "Failure - Duplicate"]
Variables List of context variables availble to template rendering (supports Macros)
  • Field Name: variables.[n]
  • Type: Array
Name Context variable name. This will appear in the context as 'variables.<name>'
  • Field Name: common_actions.[n].variables.[n].name
  • Type: String
Value Value of this variable. This field supports Macros
  • Field Name: common_actions.[n].variables.[n].value
  • Type: String
Pre-request Calls List of API calls to make before making this request
  • Field Name: pre_request_calls.[n]
  • Type: Array
Post-request Calls List of API calls to make after making this request
  • Field Name: post_request_calls.[n]
  • Type: Array
Request Template Jinja template for API request. Maps system schema to external application schema.
  • Field Name: common_actions.[n].request_template
  • Type: String
Response Template Jinja template for API response. Maps external application schema to system schema.
  • Field Name: common_actions.[n].response_template
  • Type: String