Sign in

v4

latestSwagger 2.02026-07-13109102258.7 KB
Lineage

Get lineage info of the entity specified by GUID.

get/atlas/v2/lineage/{guid}

Path parameters

guidstring required

The globally unique identifier of the entity.

Query parameters

depthinteger

The number of hops for lineage.

widthinteger

The number of max expanding width in lineage.

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

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

includeParentboolean

True to include the parent chain in the response.

getDerivedLineageboolean

True to include derived lineage in the response

Response

OK. If the request is valid.

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.

includeParentboolean

True to return the parent of the base entity.

childrenCountinteger

The number of children node.

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

The enum of lineage direction.