ODAG settings

Download OpenAPI spec

ODAG settings control tenant-level on-demand analytics generation configuration, including retention policies and resource limits. Settings are retrieved and updated as a singleton resource at the tenant level.

Note

ODAG settings can only be modified by users assigned the TenantAdmin role.

Get ODAG settings

Retrieves ODAG settings, including feature enablement status. Available only to administrators.

Facts

Rate limit Tier 1 (1000 requests per minute)

Responses

200

ODAG settings retrieved successfully.

  • application/json object

    The state of the ODAG settings available for users assigned the TenantAdmin role to view and configure.

    Show application/json properties
    • odagEnabled boolean

      Whether the ODAG feature is enabled.

    • dynamicViewEnabled boolean

      Whether the dynamic view feature is enabled.

403

Forbidden.

  • application/json object

    A standard error response containing a list of one or more errors.

    Show application/json properties
    • errors array of objects

      A single error entry within an error response.

      Show errors properties
      • code string

        A unique code used to identify the template form of the message in i18n tables (language independent).

      • meta object

        Additional metadata associated with an error.

        Show meta properties
        • statusCode integer

          The HTTP status code for the error. Generally speaking, the following codes have these meanings: 200 - Success, 201 - Success (object created), 400 - Error with user input, 403 - Authorization error (user lacks permission), 404 - Object not found, 409 - Attempt to change an object using an obsolete last ModifiedDate.

          format = int32

      • title string
      • detail string

        The message describing the error.
    • traceId string

      A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error.

500

Internal system error accessing ODAG settings.

  • application/json object

    A standard error response containing a list of one or more errors.

    Show application/json properties
    • errors array of objects

      A single error entry within an error response.

      Show errors properties
      • code string

        A unique code used to identify the template form of the message in i18n tables (language independent).

      • meta object

        Additional metadata associated with an error.

        Show meta properties
        • statusCode integer

          The HTTP status code for the error. Generally speaking, the following codes have these meanings: 200 - Success, 201 - Success (object created), 400 - Error with user input, 403 - Authorization error (user lacks permission), 404 - Object not found, 409 - Attempt to change an object using an obsolete last ModifiedDate.

          format = int32

      • title string
      • detail string

        The message describing the error.
    • traceId string

      A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error.
GET /api/analytics/odag-settings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.analytics.odagSettings.getOdagSettings()
qlik analytics odag-settings get
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "odagEnabled": true,
  "dynamicViewEnabled": true
}

Update ODAG settings

Modifies ODAG settings such as feature enablement. Available only to administrators. Changes apply immediately to all ODAG operations.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

A JSON payload containing the content for the new settings.

  • application/json object

    An object that defines the properties of ODAG settings to be modified.

    Show application/json properties
    • odagEnabled boolean
    • dynamicViewEnabled boolean

Responses

200

ODAG settings updated successfully.

  • application/json object

    The state of the ODAG settings available for users assigned the TenantAdmin role to view and configure.

    Show application/json properties
    • odagEnabled boolean

      Whether the ODAG feature is enabled.

    • dynamicViewEnabled boolean

      Whether the dynamic view feature is enabled.

403

Access denied. You lack permission to modify ODAG settings.

  • application/json object

    A standard error response containing a list of one or more errors.

    Show application/json properties
    • errors array of objects

      A single error entry within an error response.

      Show errors properties
      • code string

        A unique code used to identify the template form of the message in i18n tables (language independent).

      • meta object

        Additional metadata associated with an error.

        Show meta properties
        • statusCode integer

          The HTTP status code for the error. Generally speaking, the following codes have these meanings: 200 - Success, 201 - Success (object created), 400 - Error with user input, 403 - Authorization error (user lacks permission), 404 - Object not found, 409 - Attempt to change an object using an obsolete last ModifiedDate.

          format = int32

      • title string
      • detail string

        The message describing the error.
    • traceId string

      A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error.

500

Internal system error accessing ODAG settings.

  • application/json object

    A standard error response containing a list of one or more errors.

    Show application/json properties
    • errors array of objects

      A single error entry within an error response.

      Show errors properties
      • code string

        A unique code used to identify the template form of the message in i18n tables (language independent).

      • meta object

        Additional metadata associated with an error.

        Show meta properties
        • statusCode integer

          The HTTP status code for the error. Generally speaking, the following codes have these meanings: 200 - Success, 201 - Success (object created), 400 - Error with user input, 403 - Authorization error (user lacks permission), 404 - Object not found, 409 - Attempt to change an object using an obsolete last ModifiedDate.

          format = int32

      • title string
      • detail string

        The message describing the error.
    • traceId string

      A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error.
PUT /api/analytics/odag-settings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.analytics.odagSettings.putOdagSettings(
  { dynamicViewEnabled: true, odagEnabled: true },
)
qlik analytics odag-settings update
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"odagEnabled":true,"dynamicViewEnabled":true}'

Example Response

{
  "odagEnabled": true,
  "dynamicViewEnabled": true
}

Check update permission

Checks whether the current user has permission to modify ODAG settings.

Facts

Rate limit Tier 1 (1000 requests per minute)

Responses

200

Permission check completed successfully.

  • application/json object

    An object used to inform the caller whether the current user has privilege to update ODAG settings.

    Show application/json properties
    • canUpdateSettings boolean

403

Forbidden.

  • application/json object

    A standard error response containing a list of one or more errors.

    Show application/json properties
    • errors array of objects

      A single error entry within an error response.

      Show errors properties
      • code string

        A unique code used to identify the template form of the message in i18n tables (language independent).

      • meta object

        Additional metadata associated with an error.

        Show meta properties
        • statusCode integer

          The HTTP status code for the error. Generally speaking, the following codes have these meanings: 200 - Success, 201 - Success (object created), 400 - Error with user input, 403 - Authorization error (user lacks permission), 404 - Object not found, 409 - Attempt to change an object using an obsolete last ModifiedDate.

          format = int32

      • title string
      • detail string

        The message describing the error.
    • traceId string

      A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error.
GET /api/analytics/odag-settings/canupdate 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.analytics.odagSettings.getOdagSettingsUpdatePermission()
qlik analytics odag-settings canupdate get
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-settings/canupdate" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "canUpdateSettings": true
}