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

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

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

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

URI for the API Login request.

Field Name: session_based_auth_request.login_uri
Type: String

HTTP method for API login request. Default: POST

Field Name: session_based_auth_request.login_http_method
Type: String
Default: POST
Choices: ["GET", "POST"]

Use Request Body on Login

Use a request body to send login credentials.

Field Name: session_based_auth_request.use_request_body
Type: Boolean

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

Model: data/GuiCuc

Model Details