Sign in

v1

latestOpenAPI 3.0.02026-08-0482248.5 KB
impact

Get all RESOURCE level nodes

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.

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

Path parameters

idstring required

The qri for root node.

Query parameters

downinteger

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

Response

Successful Operation.

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"
      }
    ],
    "label": "Sales Data",
    "directed": true,
    "metadata": {
      "total": 1,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "producerId": "qri:db:oracle://LfxVj_3du3GYdWdNaa721lOWvbhENXEArBpl58h96YE#ZfH0lkXnTTGu7QGnIvKZpIxFNagQivBtnbC_cAoCPOs"
    }
  }
}