Qlik Sense Lineage Graphs API

openapi: 3.2.0
info:
  title: Lineage Graphs API
  version: ''
servers:
- url: https://{tenant}.{region}.qlikcloud.com
  variables:
    region:
      default: us
      description: The region the tenant is hosted in
    tenant:
      default: your-tenant
      description: Name of the tenant that will be called
tags:
- name: lineage-graphs
paths:
  /api/v1/lineage-graphs/nodes/{id}:
    get:
      tags:
      - lineage-graphs
      summary: Get lineage graphs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/graphLevelsResponse'
          description: Successful Operation.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-400'
          description: The request is in incorrect format
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-403'
          description: User does not have access to the node.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-404'
          description: The record is not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-429'
          headers:
            Retry-After:
              schema:
                type: integer
                example: 15
              description: The number of seconds until new requests are allowed
          description: Too many requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-500'
          description: Internal server error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-503'
          description: Service unavailable
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
        required: true
        description: The id (QRI) for the source node.
      - in: query
        name: collapse
        schema:
          type: boolean
          default: true
        required: false
        description: To collapse internal nodes, set to true, false otherwise.
      - in: query
        name: level
        schema:
          enum:
          - field
          - table
          - resource
          - all
          type: string
          default: resource
        required: false
        description: The graph level to retrieve.
      - in: query
        name: up
        schema:
          type: integer
          default: 5
        required: false
        description: The number of upstream levels of nodes to retrieve. (5 if not provided, -1 means unlimited)
      description: Returns lineage graphs of a source node. The id (QRI) can point to an item on the field, table and resource level.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: special
        limit: 20
      operationId: getApiV1LineageGraphsNodesById
      x-operation-id-source: derived
  /api/v1/lineage-graphs/nodes/{id}/actions/expand:
    get:
      tags:
      - lineage-graphs
      summary: Get expanded node and its edges
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/graphResponse'
          description: Successful Operation.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-400'
          description: The request is in incorrect format.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-403'
          description: User does not have access to the node.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-404'
          description: The record is not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-429'
          headers:
            Retry-After:
              schema:
                type: integer
                example: 15
              description: The number of seconds until new requests are allowed
          description: Too many requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-500'
          description: Internal server error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-503'
          description: Service unavailable
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
        required: true
        description: The id (QRI) for the source node.
      - in: query
        name: level
        schema:
          enum:
          - field
          - table
          type: string
          default: table
        required: true
        description: The level to expand to.
      - in: query
        name: node
        schema:
          type: string
        required: true
        description: The QRI of the node in the upstream graph for expansion.
      - in: query
        name: collapse
        schema:
          type: boolean
          default: true
        required: false
        description: To collapse internal nodes, set to true, false otherwise.
      - in: query
        name: up
        schema:
          type: integer
          default: 5
        required: false
        description: The number of upstream levels of nodes retrieved to expand. (5 if not provided, -1 means unlimited)
      description: Returns the expanded node and its edges. Up and downstream nodes are not part of the response, edges are. The id is the root node that lineage is requested for. The QRI of the node to expand is sent as the query parameter "node" for expansion.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: special
        limit: 20
      operationId: getApiV1LineageGraphsNodesByIdActionsExpand
      x-operation-id-source: derived
  /api/v1/lineage-graphs/nodes/{id}/actions/search:
    get:
      tags:
      - lineage-graphs
      summary: Search all labels
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/graphsResponse'
          description: Successful Operation.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-400'
          description: The request is in incorrect format.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-403'
          description: User does not have access to the node.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-404'
          description: The record is not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-429'
          headers:
            Retry-After:
              schema:
                type: integer
                example: 15
              description: The number of seconds until new requests are allowed
          description: Too many requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-500'
          description: Internal server error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-503'
          description: Service unavailable
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
        required: true
        description: The qri for root node.
      - in: query
        name: filter
        schema:
          type: string
        example: label co "label1" or label co "label2"
        required: true
        description: 'The expression that matches the SCIM filter format. The filter has to be encoded.

          The currently supported attribute is "label", attribute operator "co" (contains), and grouping operator "or". Example: ''label co "label1" or label co "label2"''. The search queries are case insensitive.

          '
      - in: query
        name: collapse
        schema:
          type: boolean
          default: true
        required: false
        description: To collapse internal nodes, set to true, false otherwise.
      - in: query
        name: up
        schema:
          type: integer
          default: 5
        required: false
        description: The number of upstream levels of nodes retrieved to search. (5 if not provided, -1 means unlimited)
      description: Returns result per level by searching all labels within a lineage graph on all available levels.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: special
        limit: 20
      operationId: getApiV1LineageGraphsNodesByIdActionsSearch
      x-operation-id-source: derived
  /api/v1/lineage-graphs/nodes/{id}/overview:
    post:
      tags:
      - lineage-graphs
      summary: Get lineage overview
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/overviewItems'
          description: Successful Operation.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/emptyReturn'
          description: Successfully created new resource.
        '207':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/multiStatusResponse'
          description: Request partially succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-400'
          description: The request is in incorrect format.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-403'
          description: User does not have access to the node.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-404'
          description: The record is not found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-500'
          description: Internal server error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse-503'
          description: Service unavailable
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
        required: true
        description: The qri for root node.
      - in: query
        name: collapse
        schema:
          type: boolean
          default: true
        required: false
        description: To collapse internal nodes, set to true, false otherwise.
      - in: query
        name: up
        schema:
          type: integer
          default: 5
        required: false
        description: The number of upstream levels of nodes retrieved to get overview from. (5 if not provided, -1 means unlimited)
      description: Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/qris'
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
      operationId: postApiV1LineageGraphsNodesByIdOverview
      x-operation-id-source: derived
components:
  schemas:
    node:
      type: object
      example: '{"label":"a","metadata":{"id":"qri:app:sense://3634fc0d-273d-429e-8d0b-1b4b1b66a1f2","subtype":"PROCESSOR","type":"DA_APP","filePath":"example.qvd"}}'
      properties:
        label:
          type: string
          example: example.qvd
          description: Name label of the node.
        metadata:
          type: object
          required:
          - id
          - type
          properties:
            id:
              type: string
              example: qri:app:sense://3634fc0d-273d-429e-8d0b-1b4b1b66a1f2
              description: The id (QRI) of the node
            type:
              type: string
              example:
              - DA_APP
              - DA_APP_LINK
              - DATASET
              - TABLE
              - FIELD
              description: The type of the node.
            fields:
              type: integer
              example: 1
              description: "The number of fields that are impacted. \nThis will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.\n"
            tables:
              type: integer
              example: 1
              description: "The number of tables that are impacted. \nThis will be returned as part of the response from /impact/{id}/overview.\n"
            subtype:
              type: string
              example:
              - PROCESSOR
              - APPLICATION
              - FILE
              description: The subtype of the node.
            filePath:
              type: string
              example: example.qvd
              description: The file path of a node
            dataAsset:
              $ref: '#/components/schemas/dataAsset'
          description: This contains additional node information such as node types, subtypes, queryExpressions, etc.
    edge:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          example: '1'
          description: The index of edges. This is only used in the POST request.
        source:
          type: string
          example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
          description: The id (QRI) of the source node on this edge.
        target:
          type: string
          example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
          description: The id (QRI) of the target node on this edge.
        metadata:
          type: object
          properties:
            type:
              type: string
        relation:
          type: string
          example:
          - LOAD
          - STORE
          - READ
          - FROM
    errorResponse-500:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-500
              meta:
                type: object
                example: '{"id":"e5c651d5-1198-45a2-be5d-f016cee0baf5"}'
                description: The meta contains additional information when requests fail due to internal errors.
              title:
                type: string
                example: Internal Server Error
              detail:
                type: string
                example: Something went wrong in the server.
        traceId:
          type: string
          example: e5c651d5-1198-45a2-be5d-f016cee0baf5
    graphLevelsResponse:
      type: object
      title: Response with graphs for requested levels
      properties:
        graph:
          $ref: '#/components/schemas/graph'
        graphs:
          $ref: '#/components/schemas/graphs'
      description: Populating graph property on single level request and graphs property on multi level requests.
    overviewItem:
      type: object
      properties:
        qri:
          type: string
          example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
          description: Input QRI that we are getting the overview for.
        lineage:
          type: array
          items:
            $ref: '#/components/schemas/lineageOverviewInfo'
    graphs:
      type: object
      title: Graphs
      properties:
        graphs:
          type: array
          items:
            $ref: '#/components/schemas/graph'
      description: The list of lineage graphs.
    dataAsset:
      type: object
      properties:
        id:
          type: string
          example: qri:app:landing://65083739daf9b2658503f93c
          description: The id (QRI) of the data asset
        type:
          type: string
          example: DI_APP
          description: The type of the data asset
        label:
          type: string
          example: example.Landing.Asset
          description: The lable of the data asset
        subtype:
          type: string
          example: LANDING_SAAS_MANAGED
          description: The subtype of the data asset
      description: The data integration data asset where the node belongs to
    graphResponse:
      type: object
      title: Response with a single graph
      properties:
        graph:
          $ref: '#/components/schemas/graph'
    errorResponse-400:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-400
              title:
                type: string
                example: Bad Request
              detail:
                type: string
                example: Something is not right in the request.
        traceId:
          type: string
          example: e5c651d5-1198-45a2-be5d-f016cee0baf5
    emptyReturn:
      type: object
    lineageOverviewInfo:
      type: object
      properties:
        tableQRI:
          type:
          - string
          - 'null'
          example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
          description: Table level QRI that the field belongs to.
        tableLabel:
          type:
          - string
          - 'null'
          example: Sales Table
          description: Table level label
        resourceQRI:
          type:
          - string
          - 'null'
          example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
          description: Resource level QRI
        resourceLabel:
          type:
          - string
          - 'null'
          example: Sales Data
          description: Resource level label
    errorResponse-403:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-403
              title:
                type: string
                example: Forbidden
              detail:
                type: string
                example: You don't have sufficient permissions to access this resource.
        traceId:
          type: string
          example: e5c651d5-1198-45a2-be5d-f016cee0baf5
    overviewItems:
      type: object
      properties:
        resources:
          type: array
          items:
            $ref: '#/components/schemas/overviewItem'
    qris:
      type: array
      items:
        type: string
        example: qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5
        description: List of qri to find direct lineage for.
    errorResponse-429:
      type: object
      properties:
        code:
          type: string
          example: RATE-001
        title:
          type: string
          example: Too many requests
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-429
              title:
                type: string
                example: Too Many Requests
              detail:
                type: string
                example: User rate limited.
    multiStatusResponseItem:
      type: object
      properties:
        code:
          type: string
          example: HTTP-404
        title:
          type: string
          example: Resource not found.
        status:
          type: integer
          example: 404
        resource:
          $ref: '#/components/schemas/overviewItem'
    errorResponse-404:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-404
              title:
                type: string
                example: Not Found
              detail:
                type: string
                example: The resource either never existed, or may have been deleted.
        traceId:
          type: string
          example: e5c651d5-1198-45a2-be5d-f016cee0baf5
    graphsResponse:
      type: object
      title: Response with all graphs
      properties:
        graphs:
          $ref: '#/components/schemas/graphs'
    multiStatusResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/multiStatusResponseItem'
    errorResponse-503:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: HTTP-503
              title:
                type: string
                example: Service Unavailable
              detail:
                type: string
                example: The service is unavailable.
        traceId:
          type: string
          example: e5c651d5-1198-45a2-be5d-f016cee0baf5
    nodes:
      type: object
      example: '{"qri:app:sense://3634fc0d-273d-429e-8d0b-1b4b1b66a1f2":{"label":"a","metadata":{"id":"qri:app:sense://3634fc0d-273d-429e-8d0b-1b4b1b66a1f2","subtype":"PROCESSOR","type":"DA_APP","filePath":"example.qvd"}}}'
      description: All the nodes contained in a graph.
      additionalProperties:
        $ref: '#/components/schemas/node'
    graph:
      type: object
      properties:
        type:
          type: string
          example: RESOURCE
        edges:
          type: array
          items:
            $ref: '#/components/schemas/edge'
        label:
          type: string
          example: Sales Data
          description: Label string for this graph.
        nodes:
          $ref: '#/components/schemas/nodes'
        directed:
          type: boolean
          example: true
          description: Returns true if the graph is directed.
        metadata:
          type: object
          properties:
            total:
              type: integer
              example: 1
              description: The total number of nodes retrieved in this graph.
            createdAt:
              type: string
              example: '2023-10-05T14:48:00.000Z'
              description: The date and time when the graph is created.
            producerId:
              type: string
              example: qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs
              description: The id (QRI) of the graph producer.
            specVersion:
              type: string
              example: 1
            producerType:
              type: string
              example:
              - QDA
              - EXTERNAL
              description: The type of the graph producer.
      description: The lineage graph containing the node.