PurviewLineages.GetLineageGraph Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get lineage info of the entity specified by GUID.
public virtual Azure.Response GetLineageGraph (string guid, string direction, int? depth = default, int? width = default, bool? includeParent = default, bool? getDerivedLineage = default, Azure.RequestContext context = default);
abstract member GetLineageGraph : string * string * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetLineageGraph : string * string * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response
Public Overridable Function GetLineageGraph (guid As String, direction As String, Optional depth As Nullable(Of Integer) = Nothing, Optional width As Nullable(Of Integer) = Nothing, Optional includeParent As Nullable(Of Boolean) = Nothing, Optional getDerivedLineage As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Response
Parameters
- guid
- String
The globally unique identifier of the entity.
- direction
- String
The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT".
- context
- RequestContext
The request context, which can override default behaviors on the request on a per-call basis.
Returns
Exceptions
guid
or direction
is null.
guid
is an empty string, and was expected to be non-empty.
Remarks
Schema for Response Body
:
{
baseEntityGuid: string,
guidEntityMap: Dictionary<string, AtlasEntityHeader>,
widthCounts: Dictionary<string, Dictionary<string, AnyObject>>,
lineageDepth: number,
lineageWidth: number,
includeParent: boolean,
childrenCount: number,
lineageDirection: "INPUT" | "OUTPUT" | "BOTH",
parentRelations: [
{
childEntityId: string,
relationshipId: string,
parentEntityId: string
}
],
relations: [
{
fromEntityId: string,
relationshipId: string,
toEntityId: string
}
]
}
Schema for Response Error
:
{
requestId: string,
errorCode: string,
errorMessage: string
}