Lineage graphs

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

Endpoints

GET

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

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

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

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

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

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

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

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

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

levelstring
Required

The level to get the nodes on.

Can be one of: "field""table"

default = "table"
nodestring
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.
downinteger

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

idstring
Required

The QRI for base node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphobject
  
  The lineage graph containing the node.
  
  Show graph properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/impact/{id}/actions/expand',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph impact expand <impactId>

Response

{
  "graph": {
    "type": "string",
    "edges": [
      {
        "id": "string",
        "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": "string",
    "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": 42,
      "createdAt": "string",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": "string",
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

filterstring
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.
downinteger

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

idstring
Required

The qri for root node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphsobject
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphsarray of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/impact/{id}/actions/search',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph impact search <impactId>

Response

{
  "graphs": {
    "graphs": [
      {
        "type": "string",
        "edges": [
          {
            "id": "string",
            "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": "string",
        "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": 42,
          "createdAt": "string",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": "string",
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

downinteger

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

idstring
Required

The qri for root node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphobject
  
  The lineage graph containing the node.
  
  Show graph properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/impact/{id}/overview',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph impact overview <impactId>

Response

{
  "graph": {
    "type": "string",
    "edges": [
      {
        "id": "string",
        "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": "string",
    "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": 42,
      "createdAt": "string",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": "string",
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The id (QRI) for root node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphsobject
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphsarray of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/impact/{id}/source',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph impact source <impactId>

Response

{
  "graphs": {
    "graphs": [
      {
        "type": "string",
        "edges": [
          {
            "id": "string",
            "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": "string",
        "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": 42,
          "createdAt": "string",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": "string",
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

collapseboolean

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

default = true
levelstring

The graph level to retrieve.

Can be one of: "field""table""resource""all"

default = "resource"
upinteger

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

default = 5, default = 5

Path Parameters

idstring
Required

The id (QRI) for the source node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphobject
  
  The lineage graph containing the node.
  
  Show graph properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.
- graphsobject
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphsarray of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/nodes/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph node get <nodeId>

Response

{
  "graph": {
    "type": "string",
    "edges": [
      {
        "id": "string",
        "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": "string",
    "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": 42,
      "createdAt": "string",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": "string",
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  },
  "graphs": {
    "graphs": [
      {
        "type": "string",
        "edges": [
          {
            "id": "string",
            "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": "string",
        "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": 42,
          "createdAt": "string",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": "string",
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

levelstring
Required

The level to expand to.

Can be one of: "field""table"

default = "table"
nodestring
Required

The QRI of the node in the upstream graph for expansion.
collapseboolean

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

default = true
upinteger

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

default = 5, default = 5

Path Parameters

idstring
Required

The id (QRI) for the source node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphobject
  
  The lineage graph containing the node.
  
  Show graph properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/nodes/{id}/actions/expand',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph node expand <nodeId>

Response

{
  "graph": {
    "type": "string",
    "edges": [
      {
        "id": "string",
        "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": "string",
    "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": 42,
      "createdAt": "string",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
      "specVersion": "string",
      "producerType": [
        "QDA",
        "EXTERNAL"
      ]
    }
  }
}

Facts

Rate limit	Special (20 requests per minute)
Categories	manage

Query Parameters

filterstring
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.
collapseboolean

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

default = true
upinteger

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

default = 5, default = 5

Path Parameters

idstring
Required

The qri for root node.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- graphsobject
  
  The list of lineage graphs.
  
  Show graphs properties
  
  graphsarray of objects
  
  The lineage graph containing the node.
  
  Show graphs properties
  
  typestring
  
  edgesarray of objects
  
  Show edges properties
  
  idstring
  
  The index of edges. This is only used in the POST request.
  
  sourcestring
  
  The id (QRI) of the source node on this edge.
  
  targetstring
  
  The id (QRI) of the target node on this edge.
  
  metadataobject
  
  Show metadata properties
  
  typestring
  
  relationstring
  
  labelstring
  
  Label string for this graph.
  
  nodesobject
  
  All the nodes contained in a graph.
  
  additional properties
  
  directedboolean
  
  Returns true if the graph is directed.
  
  metadataobject
  
  Show metadata properties
  
  totalinteger
  
  The total number of nodes retrieved in this graph.
  
  createdAtstring
  
  The date and time when the graph is created.
  
  producerIdstring
  
  The id (QRI) of the graph producer.
  
  specVersionstring
  
  producerTypestring
  
  The type of the graph producer.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

429

application/json

Too many requests

application/jsonobject
Show application/json properties
- codestring
- titlestring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/nodes/{id}/actions/search',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik lineage-graph node search <nodeId>

Response

{
  "graphs": {
    "graphs": [
      {
        "type": "string",
        "edges": [
          {
            "id": "string",
            "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": "string",
        "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": 42,
          "createdAt": "string",
          "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
          "specVersion": "string",
          "producerType": [
            "QDA",
            "EXTERNAL"
          ]
        }
      }
    ]
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Query Parameters

collapseboolean

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

default = true
upinteger

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

idstring
Required

The qri for root node.

Request Body

application/json

List of qri to find direct lineage for.

application/jsonarray of strings

List of qri to find direct lineage for.

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- resourcesarray of objects
  
  Show resources properties
  
  qristring
  
  Input QRI that we are getting the overview for.
  
  lineagearray of objects
  
  Show lineage properties
  
  tableQRIstring
  
  Table level QRI that the field belongs to.
  
  tableLabelstring
  
  Table level label
  
  resourceQRIstring
  
  Resource level QRI
  
  resourceLabelstring
  
  Resource level label

201

application/json

Successfully created new resource.

application/jsonobject

207

application/json

Request partially succeeded.

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  codestring
  
  titlestring
  
  statusinteger
  
  resourceobject
  
  Show resource properties
  
  qristring
  
  Input QRI that we are getting the overview for.
  
  lineagearray of objects
  
  Show lineage properties
  
  tableQRIstring
  
  Table level QRI that the field belongs to.
  
  tableLabelstring
  
  Table level label
  
  resourceQRIstring
  
  Resource level QRI
  
  resourceLabelstring
  
  Resource level label

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

User does not have access to the node.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

404

application/json

The record is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

500

application/json

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  metaobject
  
  The meta contains additional inforomation when requests fail due to internal errors.
  
  titlestring
  
  detailstring
- traceIdstring

503

application/json

Service unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

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

curl "https://your-tenant.us.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"]'

const https = require('https')
  const data = JSON.stringify(["qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/lineage-graphs/nodes/{id}/overview',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik lineage-graph node overview <nodeId>

Request

[
  "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
]

Response

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

Lineage graphs

Endpoints

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

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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

Facts

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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

Query Parameters

Path Parameters

Responses

200

400

403

404

429

500

503

Response

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