Lineage graphs

Lineage-graphs represents the lineage information for a specific Qlik item.

Download OpenAPI spec

Endpoints

GET

/api/v1/lineage-graphs/impact/{id}/actions/expand
GET

/api/v1/lineage-graphs/impact/{id}/actions/search
GET

/api/v1/lineage-graphs/impact/{id}/overview
GET

/api/v1/lineage-graphs/impact/{id}/source
GET

/api/v1/lineage-graphs/nodes/{id}
GET

/api/v1/lineage-graphs/nodes/{id}/actions/expand
GET

/api/v1/lineage-graphs/nodes/{id}/actions/search
POST

/api/v1/lineage-graphs/nodes/{id}/overview

Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

level string

Required

The level to get the nodes on.

Can be one of: "field""table"
default = "table"
node string

Required

The node in the downstream graph to get next-level nodes for. For instance, to get the TABLE level nodes inside a RESOURCE level node, use the RESOURCE level QRI for the node. Similarly, use the TABLE level QRI to get the FIELD level nodes. If a TABLE level QRI is used with level parameter being TABLE, only the RESOURCE level of the node will be taken into consideration.
down integer

The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage)

default = 5, default = 5

Path Parameters

id string

Required

The QRI for base node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graph object
  
  The lineage graph containing the node.
  
  Show graph properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/impact/{id}/actions/expand

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.expandLineageGraphImpact(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  { level: 'field', node: 'string' },
)

qlik lineage-graph impact expand 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5' \
  --level 'field' \
  --node 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/actions/expand" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graph": {
    "type": "RESOURCE",
    "edges": [
      {
        "id": "1",
        "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "metadata": {
          "type": "string"
        },
        "relation": [
          "LOAD",
          "STORE",
          "READ",
          "FROM"
        ]
      }
    ],
    "label": "Sales Data",
    "nodes": "{\"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\"}}}",
    "directed": true,
    "metadata": {
      "total": 1,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": 1,
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Searchs all labels within a impact graph on all available levels. Returns result per level.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

filter string

Required

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 insensetive.
down integer

The number of downstream resource levels nodes to search. (5 if not provided, -1 means unlimited) and 1 means direct lineage.

default = 5, default = 5

Path Parameters

id string

Required

The qri for root node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graphs object
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphs array of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/impact/{id}/actions/search

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.searchLineageGraphImpact(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  {
    filter:
      'label co "label1" or label co "label2"',
  },
)

qlik lineage-graph impact search 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5' \
  --filter 'label co "label1" or label co "label2"'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/actions/search" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graphs": {
    "graphs": [
      {
        "type": "RESOURCE",
        "edges": [
          {
            "id": "1",
            "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "metadata": {
              "type": "string"
            },
            "relation": [
              "LOAD",
              "STORE",
              "READ",
              "FROM"
            ]
          }
        ],
        "label": "Sales Data",
        "nodes": "{\"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\"}}}",
        "directed": true,
        "metadata": {
          "total": 1,
          "createdAt": "2023-10-05T14:48:00.000Z",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": 1,
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Returns all RESOURCE level nodes that are impacted by a change in the source node. The number of tables and fields that are impacted for each resource are included as metadata. The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

down integer

The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage)

default = 5, default = 5

Path Parameters

id string

Required

The qri for root node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graph object
  
  The lineage graph containing the node.
  
  Show graph properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/impact/{id}/overview

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.getLineageGraphImpactOverview(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  {},
)

qlik lineage-graph impact overview 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/overview" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graph": {
    "type": "RESOURCE",
    "edges": [
      {
        "id": "1",
        "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "metadata": {
          "type": "string"
        },
        "relation": [
          "LOAD",
          "STORE",
          "READ",
          "FROM"
        ]
      }
    ],
    "label": "Sales Data",
    "nodes": "{\"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\"}}}",
    "directed": true,
    "metadata": {
      "total": 1,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": 1,
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Returns all levels of the requested root node. Only node information will be returned.

Facts

Rate limit

Special (20 requests per minute)

Path Parameters

id string

Required

The id (QRI) for root node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graphs object
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphs array of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/impact/{id}/source

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.getLineageGraphImpactSource(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
)

qlik lineage-graph impact source 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/source" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graphs": {
    "graphs": [
      {
        "type": "RESOURCE",
        "edges": [
          {
            "id": "1",
            "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "metadata": {
              "type": "string"
            },
            "relation": [
              "LOAD",
              "STORE",
              "READ",
              "FROM"
            ]
          }
        ],
        "label": "Sales Data",
        "nodes": "{\"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\"}}}",
        "directed": true,
        "metadata": {
          "total": 1,
          "createdAt": "2023-10-05T14:48:00.000Z",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": 1,
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Returns lineage graphs of a source node. The id (QRI) can point to an item on the field, table and resource level.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

collapse boolean

To collapse internal nodes, set to true, false otherwise.

default = true
level string

The graph level to retrieve.

Can be one of: "field""table""resource""all"
default = "resource"
up integer

The number of upstream levels of nodes to retrieve. (5 if not provided, -1 means unlimited)

default = 5, default = 5

Path Parameters

id string

Required

The id (QRI) for the source node.

Responses

200

Successful Operation.

application/json object

Populating graph property on single level request and graphs property on multi level requests.
Show application/json properties
- graph object
  
  The lineage graph containing the node.
  
  Show graph properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.
- graphs object
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphs array of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/nodes/{id}

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.getLineageGraphNode(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  {},
)

qlik lineage-graph node get 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graph": {
    "type": "RESOURCE",
    "edges": [
      {
        "id": "1",
        "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "metadata": {
          "type": "string"
        },
        "relation": [
          "LOAD",
          "STORE",
          "READ",
          "FROM"
        ]
      }
    ],
    "label": "Sales Data",
    "nodes": "{\"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\"}}}",
    "directed": true,
    "metadata": {
      "total": 1,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": 1,
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  },
  "graphs": {
    "graphs": [
      {
        "type": "RESOURCE",
        "edges": [
          {
            "id": "1",
            "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "metadata": {
              "type": "string"
            },
            "relation": [
              "LOAD",
              "STORE",
              "READ",
              "FROM"
            ]
          }
        ],
        "label": "Sales Data",
        "nodes": "{\"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\"}}}",
        "directed": true,
        "metadata": {
          "total": 1,
          "createdAt": "2023-10-05T14:48:00.000Z",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": 1,
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

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.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

level string

Required

The level to expand to.

Can be one of: "field""table"
default = "table"
node string

Required

The QRI of the node in the upstream graph for expansion.
collapse boolean

To collapse internal nodes, set to true, false otherwise.

default = true
up integer

The number of upstream levels of nodes retrieved to expand. (5 if not provided, -1 means unlimited)

default = 5, default = 5

Path Parameters

id string

Required

The id (QRI) for the source node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graph object
  
  The lineage graph containing the node.
  
  Show graph properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/nodes/{id}/actions/expand

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.expandLineageGraphNode(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  { level: 'field', node: 'string' },
)

qlik lineage-graph node expand 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5' \
  --level 'field' \
  --node 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}/actions/expand" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graph": {
    "type": "RESOURCE",
    "edges": [
      {
        "id": "1",
        "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
        "metadata": {
          "type": "string"
        },
        "relation": [
          "LOAD",
          "STORE",
          "READ",
          "FROM"
        ]
      }
    ],
    "label": "Sales Data",
    "nodes": "{\"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\"}}}",
    "directed": true,
    "metadata": {
      "total": 1,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": 1,
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Returns result per level by searching all labels within a lineage graph on all available levels.

Facts

Rate limit

Special (20 requests per minute)

Query Parameters

filter string

Required

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.
collapse boolean

To collapse internal nodes, set to true, false otherwise.

default = true
up integer

The number of upstream levels of nodes retrieved to search. (5 if not provided, -1 means unlimited)

default = 5, default = 5

Path Parameters

id string

Required

The qri for root node.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- graphs object
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphs array of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  type string
  
  edges array of objects
  
  Show edges properties
  
  id string
  
  The index of edges. This is only used in the POST request.
  
  source string
  
  The id (QRI) of the source node on this edge.
  
  target string
  
  The id (QRI) of the target node on this edge.
  
  metadata object
  
  Show metadata properties
  
  type string
  
  relation string
  
  label string
  
  Label string for this graph.
  
  nodes object
  
  All the nodes contained in a graph.
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  label string
  
  Name label of the node.
  
  metadata object
  
  This contains additional node information such as node types, subtypes, queryExpressions, etc.
  
  Show metadata properties
  
  id string
  
  Required
  
  The id (QRI) of the node
  
  type string
  
  Required
  
  The type of the node.
  
  fields integer
  
  The number of fields that are impacted. This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level.
  
  tables integer
  
  The number of tables that are impacted. This will be returned as part of the response from /impact/{id}/overview.
  
  subtype string
  
  The subtype of the node.
  
  filePath string
  
  The file path of a node
  
  dataAsset object
  
  The data integration data asset where the node belongs to
  
  Show dataAsset properties
  
  id string
  
  The id (QRI) of the data asset
  
  type string
  
  The type of the data asset
  
  label string
  
  The lable of the data asset
  
  subtype string
  
  The subtype of the data asset
  
  directed boolean
  
  Returns true if the graph is directed.
  
  metadata object
  
  Show metadata properties
  
  total integer
  
  The total number of nodes retrieved in this graph.
  
  createdAt string
  
  The date and time when the graph is created.
  
  producerId string
  
  The id (QRI) of the graph producer.
  
  specVersion string
  
  producerType string
  
  The type of the graph producer.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

429

Too many requests

application/json object
Show application/json properties
- code string
- title string
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/lineage-graphs/nodes/{id}/actions/search

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.searchLineageGraphNode(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  {
    filter:
      'label co "label1" or label co "label2"',
  },
)

qlik lineage-graph node search 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5' \
  --filter 'label co "label1" or label co "label2"'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}/actions/search" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "graphs": {
    "graphs": [
      {
        "type": "RESOURCE",
        "edges": [
          {
            "id": "1",
            "source": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "target": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
            "metadata": {
              "type": "string"
            },
            "relation": [
              "LOAD",
              "STORE",
              "READ",
              "FROM"
            ]
          }
        ],
        "label": "Sales Data",
        "nodes": "{\"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\"}}}",
        "directed": true,
        "metadata": {
          "total": 1,
          "createdAt": "2023-10-05T14:48:00.000Z",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": 1,
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

collapse boolean

To collapse internal nodes, set to true, false otherwise.

default = true
up integer

The number of upstream levels of nodes retrieved to get overview from. (5 if not provided, -1 means unlimited)

default = 5, default = 5

Path Parameters

id string

Required

The qri for root node.

Request Body

application/json array of strings

List of qri to find direct lineage for.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- resources array of objects
  
  Show resources properties
  
  qri string
  
  Input QRI that we are getting the overview for.
  
  lineage array of objects
  
  Show lineage properties
  
  tableQRI string
  
  Table level QRI that the field belongs to.
  
  tableLabel string
  
  Table level label
  
  resourceQRI string
  
  Resource level QRI
  
  resourceLabel string
  
  Resource level label

201

Successfully created new resource.

application/json object

207

Request partially succeeded.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  code string
  
  title string
  
  status integer
  
  resource object
  
  Show resource properties
  
  qri string
  
  Input QRI that we are getting the overview for.
  
  lineage array of objects
  
  Show lineage properties
  
  tableQRI string
  
  Table level QRI that the field belongs to.
  
  tableLabel string
  
  Table level label
  
  resourceQRI string
  
  Resource level QRI
  
  resourceLabel string
  
  Resource level label

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the node.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

The record is not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  The meta contains additional information when requests fail due to internal errors.
  
  title string
  
  detail string
- traceId string

503

Service unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/lineage-graphs/nodes/{id}/overview

import { createQlikApi } from '@qlik/api'

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

await qlik.lineageGraphs.createLineageGraphNodeOverview(
  'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  {},
  [
    'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5',
  ],
)

qlik lineage-graph node overview 'qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}/overview" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '["qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"]'

Example Response

{
  "resources": [
    {
      "qri": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
      "lineage": [
        {
          "tableQRI": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
          "tableLabel": "Sales Table",
          "resourceQRI": "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
          "resourceLabel": "Sales Data"
        }
      ]
    }
  ]
}

Lineage graphs

Endpoints

Get next-level nodes

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Search all labels

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Get all RESOURCE level nodes

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Get impact sources

Facts

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Get lineage graphs

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Get expanded node and its edges

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Example Response

Search all labels