ODAG apps

Download OpenAPI spec

ODAG applications are accessible through a read-only API. Discover and list applications filtered by type: selection (entry points), template (source applications for generation), or generated (on-demand applications created from ODAG requests).

Note

This API is read-only. All mutations on generated applications are performed through the ODAG Requests API.

List ODAG Analytics Applications by type

Retrieves ODAG Analytics Applications filtered by type: selection (used as entry points), template (source Analytics Application for generation), or generated (Analytics Applications created via ODAG requests).

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • appType string
    Required

    The type of ODAG Analytics Application.

    Can be one of: "selection""template""generated"

Responses

200

Successful response.

  • application/json object

    The response body for ODAG Analytics Applications.

    Show application/json properties
    • data array of objects

      Condensed state of an Analytics Application returned in state for Link, LinkUsage, Request, and ODAG Apps GET calls.

      Show data properties
      • id string
        Required

        The system-assigned ID for an Analytics Application.

        minLength = 1

      • name string
        Required

        The name of an Analytics Application.

        minLength = 1

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-apps 
import { createQlikApi } from '@qlik/api'


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


await qlik.analytics.odagApps.getOdagApps({
  appType: 'selection',
})
qlik analytics odag-app ls \
  --appType 'selection'
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-apps" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "name": "appname"
    }
  ]
}