Qlik Sense Enterprise Links API

openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Service About Links API
  description: REST API for retrieving product information about a Qlik Sense site, including system details, installed components, external URLs, and third-party software information. The About Service API provides read-only endpoints that return JSON-formatted information about the Qlik Sense deployment.
  version: 2025.11.0
  contact:
    name: Qlik Support
    url: https://community.qlik.com/
  license:
    name: Proprietary
    url: https://www.qlik.com/us/legal/terms-of-use
  x-providerName: Qlik
  x-serviceName: qlik-sense-about-service
servers:
- url: https://{server}/api/about/v1
  description: About Service API via HTTPS
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
security:
- xrfkey: []
tags:
- name: Links
  description: Manage navigation links that connect selection apps to template apps for on-demand app generation
paths:
  /links:
    get:
      operationId: getOdagLinks
      summary: Qlik Sense Enterprise List navigation links
      description: Retrieves a list of ODAG navigation links and their properties. Each link connects a selection app to a template app for on-demand app generation.
      tags:
      - Links
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: Navigation links returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OdagLink'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createOdagLink
      summary: Qlik Sense Enterprise Create navigation link
      description: Creates a new navigation link that enables ODAG navigation from a designated selection app to a template app. Links created via the API do not appear in the list of available navigation links in the UI.
      tags:
      - Links
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OdagLinkCreate'
      responses:
        '201':
          description: Navigation link created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OdagLink'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /links/{linkId}:
    get:
      operationId: getOdagLink
      summary: Qlik Sense Enterprise Get navigation link by ID
      description: Retrieves a single ODAG navigation link by its unique identifier.
      tags:
      - Links
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/LinkIdParam'
      responses:
        '200':
          description: Navigation link returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OdagLink'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateOdagLink
      summary: Qlik Sense Enterprise Update navigation link
      description: Updates an existing ODAG navigation link configuration.
      tags:
      - Links
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/LinkIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OdagLinkUpdate'
      responses:
        '200':
          description: Navigation link updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OdagLink'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteOdagLink
      summary: Qlik Sense Enterprise Delete navigation link
      description: Deletes an ODAG navigation link. Generated apps associated with the link are not affected.
      tags:
      - Links
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/LinkIdParam'
      responses:
        '204':
          description: Navigation link deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    LinkIdParam:
      name: linkId
      in: path
      required: true
      description: Unique identifier of the navigation link
      schema:
        type: string
        format: uuid
    XrfKeyParam:
      name: Xrfkey
      in: query
      required: true
      description: Cross-site request forgery prevention key matching the X-Qlik-Xrfkey header.
      schema:
        type: string
        minLength: 16
        maxLength: 16
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters or body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    OdagLinkCreate:
      type: object
      properties:
        name:
          type: string
          description: Navigation link name
        selectionAppId:
          type: string
          format: uuid
          description: ID of the selection app
        templateAppId:
          type: string
          format: uuid
          description: ID of the template app
        properties:
          $ref: '#/components/schemas/OdagLinkProperties'
      required:
      - name
      - selectionAppId
      - templateAppId
    OdagLinkUpdate:
      type: object
      properties:
        name:
          type: string
          description: Updated navigation link name
        properties:
          $ref: '#/components/schemas/OdagLinkProperties'
    OdagLinkProperties:
      type: object
      properties:
        rowEstExpr:
          type: string
          description: Expression for estimating the number of rows in the generated app
        bindings:
          type: array
          items:
            $ref: '#/components/schemas/OdagBinding'
          description: Field bindings between selection and template apps
        genAppAccessible:
          type: boolean
          description: Whether generated apps are accessible to users
        publishTo:
          type: string
          description: Stream ID to publish generated apps to
        retention:
          type: object
          properties:
            maxAge:
              type: integer
              description: Maximum age in minutes before a generated app is removed
            maxCount:
              type: integer
              description: Maximum number of generated apps to retain per user
    OdagLink:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique link identifier
        createdDate:
          type: string
          format: date-time
          description: Date the link was created
        modifiedDate:
          type: string
          format: date-time
          description: Date the link was last modified
        name:
          type: string
          description: Navigation link name
        selectionAppId:
          type: string
          format: uuid
          description: ID of the selection app
        templateAppId:
          type: string
          format: uuid
          description: ID of the template app
        properties:
          $ref: '#/components/schemas/OdagLinkProperties'
        owner:
          type: string
          description: Owner user identifier
        status:
          type: string
          description: Link status
    OdagBinding:
      type: object
      properties:
        selectionField:
          type: string
          description: Field name in the selection app
        templateField:
          type: string
          description: Field name in the template app
        selectionType:
          type: string
          description: Type of selection binding
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  securitySchemes:
    xrfkey:
      type: apiKey
      in: header
      name: X-Qlik-Xrfkey
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.