Lineage - Get

Service:

Purview

API Version:

2023-09-01

Get lineage info of the entity specified by GUID.

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?direction={direction}

With optional parameters:

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?depth={depth}&direction={direction}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
guid	path	True	string	The globally unique identifier of the entity.
direction	query	True	LineageDirection	The direction of the lineage, which could be INPUT, OUTPUT or BOTH.
depth	query		integer int32	The number of hops for lineage.

Responses

Name	Type	Description
200 OK	AtlasLineageInfo	The request has succeeded.
Other Status Codes	AtlasErrorResponse	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Lineage_Get

Sample request

HTTP

GET {endpoint}/datamap/api/atlas/v2/lineage/a6894eb3-81f3-829b-2adc-52f3e603411a?depth=1&direction=INPUT

Sample response

Status code:

200

{
  "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a",
  "lineageDirection": "INPUT",
  "lineageDepth": 1,
  "lineageWidth": 1,
  "childrenCount": 1,
  "guidEntityMap": {},
  "widthCounts": {},
  "relations": [],
  "parentRelations": []
}

Definitions

Name	Description
AtlasClassification	An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasEntityHeader	An instance of an entity - like hive_table, hive_database.
AtlasErrorResponse	An error response from the service
AtlasLineageInfo	The lineage information.
AtlasTermAssignmentHeader	The header for term assignment.
AtlasTermAssignmentStatus	Status for term assignment
EntityStatus	Status - can be active or deleted
LineageDirection	Lineage direction
LineageRelation	The lineage relation with GUID of the from and to entity.
ParentRelation	The lineage parents relation with GUID of the parent entity and to child entity.
TimeBoundary	Captures time-boundary details

AtlasClassification

An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.

Name	Type	Description
attributes		The attributes of the struct.
entityGuid	string	The GUID of the entity.
entityStatus	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
lastModifiedTS	string	ETag for concurrency control.
removePropagationsOnEntityDelete	boolean	Determines if propagations will be removed on entity deletion.
typeName	string	The name of the type.
validityPeriods	TimeBoundary[]	An array of time boundaries indicating validity periods.

AtlasEntityHeader

An instance of an entity - like hive_table, hive_database.

Name	Type	Description
attributes		The attributes of the struct.
classificationNames	string[]	An array of classification names.
classifications	AtlasClassification[]	An array of classifications.
displayText	string	The display text.
guid	string	The GUID of the record.
isIncomplete	boolean	Whether it is a shell entity
labels	string[]	labels
lastModifiedTS	string	ETag for concurrency control.
meaningNames	string[]	An array of meanings.
meanings	AtlasTermAssignmentHeader[]	An array of term assignment headers.
status	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
typeName	string	The name of the type.

AtlasErrorResponse

An error response from the service

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
requestId	string	The request ID.

AtlasLineageInfo

The lineage information.

Name	Type	Description
baseEntityGuid	string	The GUID of the base entity.
childrenCount	integer	The number of children node.
guidEntityMap	<string,  AtlasEntityHeader>	The GUID entity map.
lineageDepth	integer	The depth of lineage.
lineageDirection	LineageDirection	The enum of lineage direction.
lineageWidth	integer	The width of lineage.
parentRelations	ParentRelation[]	An array of parentRelations relations.
relations	LineageRelation[]	An array of lineage relations.
widthCounts	object	The entity count in specific direction.

AtlasTermAssignmentHeader

The header for term assignment.

Name	Type	Description
confidence	integer	The confidence of the term assignment.
createdBy	string	The user who created the record.
description	string	The description of the term assignment.
displayText	string	The display text.
expression	string	The expression of the term assignment.
relationGuid	string	The GUID of the relationship.
status	AtlasTermAssignmentStatus	The status of terms assignment.
steward	string	The steward of the term.
termGuid	string	The GUID of the term.

AtlasTermAssignmentStatus

Status for term assignment

Name	Type	Description
DEPRECATED	string	The status is deprecated.
DISCOVERED	string	The status is discovered.
IMPORTED	string	The status is imported.
OBSOLETE	string	The status is obsolete.
OTHER	string	Other status.
PROPOSED	string	The status is proposed.
VALIDATED	string	The status is validated.

EntityStatus

Status - can be active or deleted

Name	Type	Description
ACTIVE	string	The status is active.
DELETED	string	The status is deleted.

LineageDirection

Lineage direction

Name	Type	Description
BOTH	string	both
INPUT	string	input
OUTPUT	string	output

LineageRelation

The lineage relation with GUID of the from and to entity.

Name	Type	Description
fromEntityId	string	The GUID of from-entity.
relationshipId	string	The GUID of relationship.
toEntityId	string	The GUID of to-entity.

ParentRelation

The lineage parents relation with GUID of the parent entity and to child entity.

Name	Type	Description
childEntityId	string	The GUID of child entity.
parentEntityId	string	The GUID of parent entity.
relationshipId	string	The GUID of relationship.

TimeBoundary

Captures time-boundary details

Name	Type	Description
endTime	string	The end of the time boundary.
startTime	string	The start of the time boundary.
timeZone	string	The timezone of the time boundary.