Direct Access Agents

Download specification

API for remotely managing configuration settings of Direct Access Gateway agents. Available to users with the Tenant Admin role in Direct Access Gateway v1.7.2+.

Restart an agent

Restarts the specified agent. If a reload is in RELOADING status the restart action will be ignored. Use force-restart to restart the agent even if a reload is in RELOADING status. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • agentActionstring
    Required

    The type of action to perform. Permitted values are restart (will not restart the agent if a reload is in RELOADING status) and force-restart (will restart the agent even if a reload is in RELOADING status).

  • agentIdstring
    Required

    The agent ID

Responses

204

Service restarted successfully.

400

Error restarting the service.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Service doesn't exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
POST /api/v1/direct-access-agents/{agentId}/actions/{agentAction} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/actions/{agentAction}" \
-X POST \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/actions/{agentAction}',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Get agent configuration

Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Query Parameters

  • queryPropertiesarray of strings

    Individual properties within the agent configuration

Path Parameters

  • agentIdstring
    Required

    The agent ID

Responses

200

The dictionary of key/value pairs retrieved from the configuration file.

  • application/jsonobject
    Show application/json properties
    • connectorsarray of objects
      Show connectors properties
      • settingsarray of objects
        One of:
        • ConfigurationLineNumericobject
          Show ConfigurationLineNumeric properties
          • namestring
          • valuestring
          • connectorstring
          • uiActionsarray of strings

            Values may be any of: "Read""Write"

          • apiActionsarray of strings

            Values may be any of: "Read""Write"

          • descriptionstring
          • displayNamestring
          • defaultValuestring
          • pendingValuestring
          • permittedRangeEndinteger

            format = int32

          • pendingApplicationboolean
          • allowMultipleValuesboolean
          • applyWithoutRestartboolean
          • permittedRangeStartinteger

            format = int32

        • ConfigurationLineStringobject
          Show ConfigurationLineString properties
          • namestring
          • valuestring
          • connectorstring
          • uiActionsarray of strings

            Values may be any of: "Read""Write"

          • apiActionsarray of strings

            Values may be any of: "Read""Write"

          • descriptionstring
          • displayNamestring
          • defaultValuestring
          • pendingValuestring
          • permittedValuesarray of strings
          • pendingApplicationboolean
          • allowMultipleValuesboolean
          • applyWithoutRestartboolean
      • connectorNamestring
    • dcaasSettingsarray of objects
      One of:
      • ConfigurationLineNumericobject
        Show ConfigurationLineNumeric properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

          Values may be any of: "Read""Write"

        • apiActionsarray of strings

          Values may be any of: "Read""Write"

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedRangeEndinteger

          format = int32

        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
        • permittedRangeStartinteger

          format = int32

      • ConfigurationLineStringobject
        Show ConfigurationLineString properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

          Values may be any of: "Read""Write"

        • apiActionsarray of strings

          Values may be any of: "Read""Write"

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedValuesarray of strings
        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
    • connectorAgentSettingsarray of objects
      One of:
      • ConfigurationLineNumericobject
        Show ConfigurationLineNumeric properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

          Values may be any of: "Read""Write"

        • apiActionsarray of strings

          Values may be any of: "Read""Write"

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedRangeEndinteger

          format = int32

        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
        • permittedRangeStartinteger

          format = int32

      • ConfigurationLineStringobject
        Show ConfigurationLineString properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

          Values may be any of: "Read""Write"

        • apiActionsarray of strings

          Values may be any of: "Read""Write"

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedValuesarray of strings
        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/configurations 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/configurations" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/configurations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
  "connectors": [
    {
      "settings": [
        {
          "name": "string",
          "value": "string",
          "connector": "string",
          "uiActions": [
            "Read"
          ],
          "apiActions": [
            "Read"
          ],
          "description": "string",
          "displayName": "string",
          "defaultValue": "string",
          "pendingValue": "string",
          "permittedRangeEnd": 42,
          "pendingApplication": true,
          "allowMultipleValues": true,
          "applyWithoutRestart": true,
          "permittedRangeStart": 42
        }
      ],
      "connectorName": "string"
    }
  ],
  "dcaasSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "permittedRangeEnd": 42,
      "pendingApplication": true,
      "allowMultipleValues": true,
      "applyWithoutRestart": true,
      "permittedRangeStart": 42
    }
  ],
  "connectorAgentSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "permittedRangeEnd": 42,
      "pendingApplication": true,
      "allowMultipleValues": true,
      "applyWithoutRestart": true,
      "permittedRangeStart": 42
    }
  ]
}

Update agent configuration

Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

Request Body

The JSON Patch document

  • application/jsonarray of objects
    Show application/json properties
    • opstring
      Required

      Can be one of: "add""replace""remove"

    • pathstring
      Required

      Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES"

    • valuestring
      Required

The JSON Patch document

  • application/json-patch+jsonarray of objects
    Show application/json-patch+json properties
    • opstring
      Required

      Can be one of: "add""replace""remove"

    • pathstring
      Required

      Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES"

    • valuestring
      Required

Responses

204

Patch applied.

207

Patch applied, validation results show success or failure of each individual patch operation.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • validboolean
      • operationobject
        Show operation properties
        • opstring
          Required

          Can be one of: "add""replace""remove"

        • pathstring
          Required

          Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES"

        • valuestring
          Required
      • validationResultstring
    • errorMessagestring
    • httpStatusCodeinteger

      format = int32

    • failedPatchErrorobject
      Show failedPatchError properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

415

Unsupported content-type. This endpoint must include application/json as a valid content-type for API compliance, but C# JsonPatchDocument doesn't support it. Requests must use application/json-patch+json.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PATCH /api/v1/direct-access-agents/{agentId}/configurations 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/configurations" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"AGENT_LOG_LEVEL","value":"string"}]'
const https = require('https')
  const data = JSON.stringify([{"op":"add","path":"AGENT_LOG_LEVEL","value":"string"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/configurations',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

[
  {
    "op": "add",
    "path": "AGENT_LOG_LEVEL",
    "value": "string"
  }
]

Response

{
  "data": [
    {
      "valid": true,
      "operation": {
        "op": "add",
        "path": "AGENT_LOG_LEVEL",
        "value": "string"
      },
      "validationResult": "string"
    }
  ],
  "errorMessage": "string",
  "httpStatusCode": 42,
  "failedPatchError": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

Get connector configuration files

Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    Required

    The connector to retrieve the list of files for

    Can be one of: "file-connector""rest-connector""odbc-connector"

Responses

200

The list of files for the specified connector.

  • application/jsonobject
    Show application/json properties
    • resultarray of strings
    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
  "result": [
    "string"
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

Get connector configuration

Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    Required

    The connector type to retrieve

    Can be one of: "file-connector""rest-connector""odbc-connector"

  • fileTypestring
    Required

    The type of file to retrieve

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultarray of strings
    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
  "result": [
    "string"
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

Set connector configuration

Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    Required

    The connector type to update

    Can be one of: "file-connector""rest-connector""odbc-connector"

  • fileTypestring
    Required

    The file type to update

Request Body

The contents of the file to be updated

  • application/jsonobject

    The request to update a connector flat file

    Show application/json properties
    • contentsToSavearray of strings

      Individual lines of the file. Must be escaped when sending as json.

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"contentsToSave":["C:\\\\filepath"]}'
const https = require('https')
  const data = JSON.stringify({"contentsToSave":["C:\\\\filepath"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

{
  "contentsToSave": [
    "C:\\\\filepath"
  ]
}

Get connector type mapping configuration

Retrieves custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

  • connectorTypestring
    Required

    The connector type. Must be odbc-connector for this endpoint.

    Can be one of: "odbc-connector"

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultarray of objects
      Show result properties
      • idstring
        Required

        The Identifier property in the ODBC custom data type mapping file.

        minLength = 1

      • bitboolean

        The IsBit property in the ODBC custom data type mapping file.

      • sizeinteger

        The Size property in the ODBC custom data type mapping file.

        default = 0, format = int32, default = 0

      • qlikDataTypestring
        Required

        The QlikDataType property in the ODBC custom data type mapping file.

        minLength = 1

      • nativeDataTypestring
        Required

        The NativeDataType property in the ODBC custom data type mapping file.

        minLength = 1

    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
  "result": [
    {
      "id": "Amazon Athena ODBC (x64)",
      "bit": true,
      "size": 0,
      "qlikDataType": "String",
      "nativeDataType": "varchar"
    }
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

Set connector type mapping configuration

Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

  • connectorTypestring
    Required

    The connector type. Must be odbc-connector for this endpoint.

    Can be one of: "odbc-connector"

Request Body

The contents of the file to be updated.

  • application/jsonobject
    Show application/json properties
    • odbcCustomDataTypesarray of objects
      Show odbcCustomDataTypes properties
      • idstring
        Required

        The Identifier property in the ODBC custom data type mapping file.

        minLength = 1

      • bitboolean

        The IsBit property in the ODBC custom data type mapping file.

      • sizeinteger

        The Size property in the ODBC custom data type mapping file.

        default = 0, format = int32, default = 0

      • qlikDataTypestring
        Required

        The QlikDataType property in the ODBC custom data type mapping file.

        minLength = 1

      • nativeDataTypestring
        Required

        The NativeDataType property in the ODBC custom data type mapping file.

        minLength = 1

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings 
curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"odbcCustomDataTypes":[{"id":"Amazon Athena ODBC (x64)","bit":true,"size":0,"qlikDataType":"String","nativeDataType":"varchar"}]}'
const https = require('https')
  const data = JSON.stringify({"odbcCustomDataTypes":[{"id":"Amazon Athena ODBC (x64)","bit":true,"size":0,"qlikDataType":"String","nativeDataType":"varchar"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

{
  "odbcCustomDataTypes": [
    {
      "id": "Amazon Athena ODBC (x64)",
      "bit": true,
      "size": 0,
      "qlikDataType": "String",
      "nativeDataType": "varchar"
    }
  ]
}