Lineage - Get By Unique Attribute
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 {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?direction={direction}
GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?depth={depth}&direction={direction}&attr:qualifiedName={attr:qualifiedName}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
type
|
path | True |
string |
The name of the type. |
direction
|
query | True |
The direction of the lineage, which could be INPUT, OUTPUT or BOTH. |
|
attr:qualified
|
query |
string |
The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
|
depth
|
query |
integer int32 |
The number of hops for lineage. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
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_GetByUniqueAttribute
Sample Request
GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/azure_blob_path?depth=2&direction=BOTH&attr:qualifiedName=https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/
Sample Response
{
"baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
"lineageDirection": "BOTH",
"lineageDepth": 2,
"lineageWidth": 2,
"childrenCount": -1,
"guidEntityMap": {
"9b2751f1-2633-4f06-a578-e14fab4c52fd": {
"typeName": "azure_blob_path",
"attributes": {
"owner": "testOwner",
"modifiedTime": 0,
"qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/",
"isBlob": false,
"accessTierInferred": false,
"description": "testDesc",
"committedBlockCount": 0,
"path": "/test/AzureBlobPath.json",
"size": 731,
"createTime": 0,
"name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
"blobType": "BlockBlob",
"serverEncrypted": true
},
"lastModifiedTS": "1",
"guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
"status": "ACTIVE",
"displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
"classificationNames": [
"MICROSOFT.PERSONAL.EMAIL",
"MICROSOFT.PERSONAL.NAME"
],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": []
}
},
"relations": [],
"parentRelations": [],
"widthCounts": {
"INPUT": {
"9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
},
"OUTPUT": {
"9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
}
}
}
Definitions
Name | Description |
---|---|
Atlas |
An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. |
Atlas |
An instance of an entity - like hive_table, hive_database. |
Atlas |
An error response from the service |
Atlas |
The lineage information. |
Atlas |
The header for term assignment. |
Atlas |
Status for term assignment |
Entity |
Status - can be active or deleted |
Lineage |
Lineage direction |
Lineage |
The lineage relation with GUID of the from and to entity. |
Parent |
The lineage parents relation with GUID of the parent entity and to child entity. |
Time |
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 |
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 |
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 |
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 |
An array of term assignment headers. |
|
status |
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,
Atlas |
The GUID entity map. |
lineageDepth |
integer |
The depth of lineage. |
lineageDirection |
The enum of lineage direction. |
|
lineageWidth |
integer |
The width of lineage. |
parentRelations |
An array of parentRelations relations. |
|
relations |
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 |
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. |