Get a column lineage graph

Get a column lineage graph

Query Parameters

nodeId string required

The ID of the node. A node can either be a dataset node, a dataset field node or a job node. The format of nodeId for dataset is dataset:<namespace_of_dataset>:<name_of_the_dataset>, for dataset field is datasetField:<namespace_of_dataset>:<name_of_the_dataset>:<name_of_field>, and for job is job:<namespace_of_the_job>:<name_of_the_job>.

depth integer

Default value: 20

Depth of lineage graph to create.

withDownstream boolean

Determines if downstream lineage should be returned.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

graph object[]
Array [
id string
The ID of the node.
type NodeType
Possible values: [JOB, DATASET]
The type of the diff node.
data object
The data of the node.
oneOf
object
object
---
object
The data of the node.
object
The data of the node.
inEdges object[]
The in edges of the node.
Array [
origin string
The ID of the origin node.
destination string
The ID of the destination node.
]
outEdges object[]
The out edges of the node.
Array [
origin string
The ID of the origin node.
destination string
The ID of the destination node.
]
]

{
  "graph": [
    {
      "id": "string",
      "type": "JOB",
      "data": {
        "id": {
          "namespace": "my-namespace",
          "name": "my-dataset"
        },
        "type": "DB_TABLE",
        "name": "my-dataset",
        "physicalName": "public.mytable",
        "createdAt": "2019-05-09T19:49:24.201361Z",
        "updatedAt": "2019-05-09T19:49:24.201361Z",
        "namespace": "my-namespace",
        "sourceName": "my-source",
        "fields": [
          {
            "name'": "a",
            "type": "INTEGER",
            "tags": []
          },
          {
            "name'": "b",
            "type": "TIMESTAMP",
            "tags": []
          },
          {
            "name'": "c",
            "type": "INTEGER",
            "tags": []
          },
          {
            "name'": "d",
            "type": "INTEGER",
            "tags": []
          }
        ],
        "tags": [],
        "lastModifiedAt": null,
        "description": "My first dataset!",
        "facets": {},
        "currentVersion": "b1d626a2-6d3a-475e-9ecf-943176d4a8c6"
      },
      "inEdges": [
        {
          "origin": "string",
          "destination": "string"
        }
      ],
      "outEdges": [
        {
          "origin": "string",
          "destination": "string"
        }
      ]
    }
  ]
}

GET /column-lineage

Request

Base URL

http://localhost:5000/api/v1

nodeId — query required

depth — query

withDownstream — query

---truefalse

curl / cURL

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://localhost:5000/api/v1/column-lineage' \
-H 'Accept: application/json'