Lineage graphs
Lineage-graphs represents the lineage information for a specific Qlik item.
Endpoints
Skip to sectionGET | /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 |
Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.
Facts GET /v1/lineage-graphs/impact/{id}/actions/expand
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/impact/{id}/actions/expand
id string | The QRI for base node. |
Query Parameters GET /v1/lineage-graphs/impact/{id}/actions/expand
level default='table' string | The level to get the nodes on. Enum: field table |
node string | 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 |
down optional, default=5 integer | The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) |
Responses GET /v1/lineage-graphs/impact/{id}/actions/expand
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
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 <API-key>"
Response GET /v1/lineage-graphs/impact/{id}/actions/expand
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"producerType": [
"QDA",
"EXTERNAL"
]
}
}
Search all labels within a impact graph on all available levels. Returns result per level
Facts GET /v1/lineage-graphs/impact/{id}/actions/search
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/impact/{id}/actions/search
id string | The qri for root node. |
Query Parameters GET /v1/lineage-graphs/impact/{id}/actions/search
filter string | 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. |
terms string | Comma separated, case-insensitive list of search terms. |
down optional, default=5 integer | The number of downstream resource levels nodes to search. (5 if not provided, -1 means unlimited) and 1 means direct lineage. |
Responses GET /v1/lineage-graphs/impact/{id}/actions/search
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
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 <API-key>"
Response GET /v1/lineage-graphs/impact/{id}/actions/search
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"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 GET /v1/lineage-graphs/impact/{id}/overview
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/impact/{id}/overview
id string | The qri for root node. |
Query Parameters GET /v1/lineage-graphs/impact/{id}/overview
down optional, default=5 integer | The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) |
Responses GET /v1/lineage-graphs/impact/{id}/overview
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
GET/v1/lineage-graphs/impact/{id}/overview
curl "https://your-tenant.us.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/overview" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/lineage-graphs/impact/{id}/overview
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"producerType": [
"QDA",
"EXTERNAL"
]
}
}
Returns all levels of the requested root node. Only node information will be returned.
Facts GET /v1/lineage-graphs/impact/{id}/source
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/impact/{id}/source
id string | The id (QRI) for root node. |
Responses GET /v1/lineage-graphs/impact/{id}/source
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
GET/v1/lineage-graphs/impact/{id}/source
curl "https://your-tenant.us.qlikcloud.com/api/v1/lineage-graphs/impact/{id}/source" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/lineage-graphs/impact/{id}/source
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"producerType": [
"QDA",
"EXTERNAL"
]
}
}
]
}
Returns a lineage graph of a source node. The id (QRI) can point to an item on the field, table and resource level.
Facts GET /v1/lineage-graphs/nodes/{id}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/nodes/{id}
id string | The id (QRI) for the source node. |
Query Parameters GET /v1/lineage-graphs/nodes/{id}
collapse optional, default=true boolean | To collapse internal nodes, set to true, false otherwise. |
level optional, default='resource' string | The graph level to retrieve. Enum: field table resource |
up optional, default=5 integer | The number of upstream levels of nodes to retrieve. (5 if not provided, -1 means unlimited) |
Responses GET /v1/lineage-graphs/nodes/{id}
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error |
503 optional, application/json | Service unavailable |
GET/v1/lineage-graphs/nodes/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/lineage-graphs/nodes/{id}
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"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 GET /v1/lineage-graphs/nodes/{id}/actions/expand
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/nodes/{id}/actions/expand
id string | The id (QRI) for the source node. |
Query Parameters GET /v1/lineage-graphs/nodes/{id}/actions/expand
level default='table' string | The level to expand to. Enum: field table |
node string | The QRI of the node in the upstream graph for expansion. |
collapse optional, default=true boolean | To collapse internal nodes, set to true, false otherwise. |
up optional, default=5 integer | The number of upstream levels of nodes retrieved to expand. (5 if not provided, -1 means unlimited) |
Responses GET /v1/lineage-graphs/nodes/{id}/actions/expand
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error |
503 optional, application/json | Service unavailable |
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 <API-key>"
Response GET /v1/lineage-graphs/nodes/{id}/actions/expand
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"producerType": [
"QDA",
"EXTERNAL"
]
}
}
Search all labels within a lineage graph on all available levels. Returns result per level.
Facts GET /v1/lineage-graphs/nodes/{id}/actions/search
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/lineage-graphs/nodes/{id}/actions/search
id string | The qri for root node. |
Query Parameters GET /v1/lineage-graphs/nodes/{id}/actions/search
filter string | 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. |
terms string | Comma separated, case-insensitive list of search terms. |
collapse optional, default=true boolean | To collapse internal nodes, set to true, false otherwise. |
up optional, default=5 integer | The number of upstream levels of nodes retrieved to search. (5 if not provided, -1 means unlimited) |
Responses GET /v1/lineage-graphs/nodes/{id}/actions/search
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
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 <API-key>"
Response GET /v1/lineage-graphs/nodes/{id}/actions/search
{
"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\":{\"subtype\":\"PROCESSOR\",\"type\":\"DA_APP\"}}}",
"directed": true,
"metadata": {
"total": 0,
"createdAt": "string",
"producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs",
"specVersion": "string",
"producerType": [
"QDA",
"EXTERNAL"
]
}
}
]
}
Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.
Facts POST /v1/lineage-graphs/nodes/{id}/overview
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters POST /v1/lineage-graphs/nodes/{id}/overview
id string | The qri for root node. |
Query Parameters POST /v1/lineage-graphs/nodes/{id}/overview
collapse optional, default=true boolean | To collapse internal nodes, set to true, false otherwise. |
up optional, default=5 integer | The number of upstream levels of nodes retrieved to get overview from. (5 if not provided, -1 means unlimited) |
Request Body POST /v1/lineage-graphs/nodes/{id}/overview
optional, application/json Array<string> | No description |
Responses POST /v1/lineage-graphs/nodes/{id}/overview
200 optional, application/json | Successful Operation. |
201 optional, application/json | Successfully created new resource. |
207 optional, application/json | Request partially succeeded. |
400 optional, application/json | The request is in incorrect format. |
403 optional, application/json | User does not have access to the node. |
404 optional, application/json | The record is not found. |
500 optional, application/json | Internal server error. |
503 optional, application/json | Service unavailable |
POST/v1/lineage-graphs/nodes/{id}/overview
curl "https://your-tenant.us.qlikcloud.com/api/v1/lineage-graphs/nodes/{id}/overview" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"":[]}'
Request POST /v1/lineage-graphs/nodes/{id}/overview
{
"": []
}
Response POST /v1/lineage-graphs/nodes/{id}/overview
{
"data": [
{
"code": "HTTP-404",
"title": "Resource not found.",
"status": 404,
"resource": {
"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"
}
]
}
}
]
}
edge
objectProperties
id optional string | The index of edges. This is only used in the POST request. |
source optional string | The id (QRI) of the source node on this edge. |
target optional string | The id (QRI) of the target node on this edge. |
metadata optional object | No description |
relation optional string | No description |
emptyReturn
objecterrorResponse-400
objectProperties
errors optional | No description |
traceId optional string | No description |
errorResponse-403
objectProperties
errors optional | No description |
traceId optional string | No description |
errorResponse-404
objectProperties
errors optional | No description |
traceId optional string | No description |
errorResponse-500
objectProperties
errors optional | No description |
traceId optional string | No description |
errorResponse-503
objectProperties
errors optional | No description |
traceId optional string | No description |
graph
objectThe lineage graph containing the node.
Properties
type optional string | No description |
edges optional | No description |
label optional string | Label string for this graph. |
nodes optional | All the nodes contained in a graph. |
directed optional boolean | Returns true if the graph is directed. |
metadata optional | No description |
graphs
objectThe list of lineage graphs.
Properties
graphs optional | No description |
lineageOverviewInfo
objectProperties
tableQRI optional string | Table level QRI that the field belongs to. |
tableLabel optional string | Table level label |
resourceQRI optional string | Resource level QRI |
resourceLabel optional string | Resource level label |
multiStatusResponse
objectProperties
data optional | No description |
multiStatusResponseItem
objectProperties
code optional string | No description |
title optional string | No description |
status optional integer | No description |
resource optional | No description |
node
objectProperties
label optional string | Name label of the node. |
metadata optional | This contains additional node information such as node types, subtypes, queryExpressions, etc. |
nodes
objectAll the nodes contained in a graph.
overviewItem
objectProperties
qri optional string | Input QRI that we are getting the overview for. |
lineage optional | No description |
overviewItems
objectProperties
resources optional | No description |