v3

latestSwagger 2.02026-07-139789260.9 KB

Return lineage info about entity.

In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format

attr:[attrName]=[attrValue]

NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.

The REST request would look something like this:

GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

get/atlas/v2/lineage/uniqueAttribute/type/{typeName}

Path parameters

typeNamestring required

The name of the type.

Query parameters

depthinteger

The number of hops for lineage.

direction'INPUT' | 'OUTPUT' | 'BOTH' required

The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

attr:qualifiedNamestring

The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

Response

The request has succeeded.

baseEntityGuidstring

The GUID of the base entity.

guidEntityMapobject

The GUID entity map.

widthCountsobject

The entity count in specific direction.

lineageDepthinteger

The depth of lineage.

lineageWidthinteger

The width of lineage.

childrenCountinteger

The number of children node.

lineageDirection'INPUT' | 'OUTPUT' | 'BOTH'

Lineage direction