[Index]
Stores generic driver connection parameters for interfacing to an external service.
Model ref.: data/Spark
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": {
"name": {
"required": true,
"type": "string",
"description": "Name for this instance of generic driver connection details.",
"title": "Name"
},
"description": {
"required": true,
"type": "string",
"description": "Description for this instance of generic driver connection details.",
"title": "Description"
},
"version": {
"description": "Version of models to use.",
"title": "Version",
"pattern": "^[0-9]+?(\\.[0-9]+?)+?$",
"required": true,
"type": "string"
},
"auth_method": {
"description": "Type of authentication to use when interfacing to the external service.",
"title": "Authentication Method",
"required": true,
"choices": [
{
"value": "BASIC",
"title": "HTTP Basic Authentication"
},
{
"value": "OAUTH",
"title": "OAuth(OApen Authorization)"
}
],
"type": "string"
},
"username": {
"required": false,
"type": "string",
"description": "Username to use with specified authentication method.",
"title": "Username"
},
"password": {
"is_password": true,
"description": "Password to use with specified authentication method.",
"title": "Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"token": {
"is_password": true,
"description": "Token to use with specified authentication method.",
"title": "Token",
"required": false,
"store_encrypted": true,
"type": "string"
},
"test_connection_uri": {
"required": true,
"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"
},
"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"
},
"secure_driver_parameters": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"description": "Name of additional secure driver parameter.",
"title": "Name",
"required": true,
"store_encrypted": false,
"type": "string"
},
"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"
},
"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": {
"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": {
"description": "Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.",
"title": "Type",
"required": true,
"choices": [
{
"value": "backoff_retry",
"title": "Backoff & Retry"
},
{
"value": "failure_duplicate",
"title": "Failure - Duplicate"
}
],
"type": "string"
}
}
},
"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"
},
"common_actions": {
"items": {
"type": "object",
"properties": {
"action": {
"title": "Action",
"required": true,
"type": "string",
"description": "Name of the device model operation for e.g. add"
},
"uri": {
"title": "URI",
"type": "string",
"description": "URI for the API request"
},
"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"
},
"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_format": {
"description": "Response format",
"title": "Response Format",
"default": "JSON",
"required": false,
"choices": [
{
"value": "JSON",
"title": "JSON"
},
{
"value": "XML",
"title": "XML"
}
],
"type": "string"
},
"http_method": {
"description": "HTTP method for API request",
"title": "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"
},
"response_code_template": {
"title": "Response Code Template",
"type": "string",
"description": "Jinja template for mapping API endpoint specific error/status response"
},
"request_headers": {
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"required": true,
"type": "string",
"description": "Name of HTTP request header, e.g. Accept."
},
"value": {
"title": "Value",
"required": true,
"type": "string",
"description": "Value of HTTP request header, e.g. text/plain."
}
}
},
"title": "Request Headers",
"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."
},
"response_handlers": {
"items": {
"type": "object",
"properties": {
"condition": {
"title": "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 }}."
},
"type": {
"description": "Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.",
"title": "Type",
"required": true,
"choices": [
{
"value": "backoff_retry",
"title": "Backoff & Retry"
},
{
"value": "failure_duplicate",
"title": "Failure - Duplicate"
}
],
"type": "string"
}
}
},
"title": "Response Handlers",
"type": "array",
"description": "Handlers to execute on API responses. Only those response handlers' which condition evaluate to True are executed."
},
"variables": {
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Context variable name. This will appear in the context as 'variables.<name>'"
},
"value": {
"title": "Value",
"type": "string",
"description": "Value of this variable. This field supports Macros"
}
}
},
"title": "Variables",
"type": "array",
"description": "List of context variables availble to template rendering (supports Macros)"
},
"pre_request_calls": {
"items": {
"type": "string"
},
"title": "Pre-request Calls",
"type": "array",
"description": "List of API calls to make before making this request"
},
"post_request_calls": {
"items": {
"type": "string"
},
"title": "Post-request Calls",
"type": "array",
"description": "List of API calls to make after making this request"
},
"request_template": {
"title": "Request Template",
"type": "string",
"description": "Jinja template for API request. Maps system schema to external application schema."
},
"response_template": {
"title": "Response Template",
"type": "string",
"description": "Jinja template for API response. Maps external application schema to system schema."
}
}
},
"title": "Common Actions",
"type": "array",
"description": "Actions used identically by many device models"
}
},
"schema_version": "0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Spark/add/ |
|
The GUI Add form of data/Spark 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/data/Spark | 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/data/Spark/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Spark/[pkid1]", "/api/data/Spark/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Spark/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/Spark/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/Spark/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Spark/[pkid1]", "/api/v0/data/Spark/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Spark/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Spark; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Spark/export/ |
|
{ "hrefs":["/api/data/Spark/[pkid1]", "/api/data/Spark/[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 data/Spark and the JSON format can be used to import instances of data/Spark.
GET http://[host-proxy]/api/data/Spark/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Spark | POST | /api/data/Spark/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/Spark/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Spark/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/Spark/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Spark/ |
|
The data/Spark schema and all instances as JSON. |
(The list will return 0 to 3 data/Spark instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Spark/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/Spark",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "?",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"import",
"list",
"migration",
"remove",
"test_connect",
"update"
],
"schema_version": "0.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/Spark/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Spark/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/Spark/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/Spark/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/Spark/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/Spark/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/Spark/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/Spark/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/Spark/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Spark/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Spark. | GET | /api/data/Spark/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Spark as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Spark/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Spark/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Spark/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Spark/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Test Connection | POST | /api/data/Spark/[pkid]/test_connect | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/Spark/[pkid]/import | 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 data/Spark; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Spark/[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 data/Spark and the JSON format can be used to import instances of data/Spark.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Spark/[pkid] | hierarchy=[hierarchy] | The data/Spark instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Spark/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Spark. |