Google Git
Sign in
apache / atlas-website / refs/heads/asf-site / . / 2.3.0 / api / v2 / resource_LineageREST.html
blob: 981a6d9e0d04c2ab34799ebdf27729ab6b478ce0 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>Atlas REST API: LineageREST</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Atlas REST API: LineageREST</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li><a href="#resource_LineageREST_getLineageGraph_GET"><abbr title="GET /v2/lineage/{guid}" class="side-abbr"><span class="sideoverflow">GET /v2/lineage/{guid}</span></abbr></a></li>
<li><a href="#resource_LineageREST_getLineageGraph_POST"><abbr title="POST /v2/lineage/{guid}" class="side-abbr"><span class="sideoverflow">POST /v2/lineage/{guid}</span></abbr></a></li>
<li><a href="#resource_LineageREST_getLineageByUniqueAttribute_GET"><abbr title="GET /v2/lineage/uniqueAttribute/type/{typeName}" class="side-abbr"><span class="sideoverflow">GET /v2/lineage/uniqueAttribute/type/{typeName}</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="resources.html">Resources</a></li>
<li class="dropdown"><a href="resource_LineageREST.html">LineageREST</a></li>
</ol>
<h1 class="page-header">LineageREST <small>Resource</small></h1>
<p>REST interface for an entity's lineage information</p>
<div id="resource_LineageREST_getLineageGraph_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/lineage/{guid} <a href="../v2/lineage/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Returns lineage info about entity.</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>default</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">guid</span></td>
<td>path</td>
<td><span class="parameter-description">- unique entity id</span></td>
<td><span class="parameter-default-value">&nbsp;</span></td>
<td><span class="parameter-constraints">&nbsp;</span></td>
</tr>
<tr>
<td><span class="parameter-name">depth</span></td>
<td>query</td>
<td><span class="parameter-description">- number of hops for lineage</span></td>
<td><span class="parameter-default-value">3</span></td>
<td><span class="parameter-constraints">int</span></td>
</tr>
<tr>
<td><span class="parameter-name">direction</span></td>
<td>query</td>
<td><span class="parameter-description">- input, output or both</span></td>
<td><span class="parameter-default-value">BOTH</span></td>
<td><span class="parameter-constraints">"BOTH" or "INPUT" or "OUTPUT"</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-codes">
<caption>Response Codes</caption>
<thead>
<tr>
<th>code</th>
<th>condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">If Lineage exists for the given entity</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">Bad query parameters</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">If no lineage is found for the given entity</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response Body</caption>
<thead>
<tr>
<th>media type</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_AtlasLineageInfo.html">AtlasLineageInfo</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">AtlasLineageInfo</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_AtlasLineageInfo.html">AtlasLineageInfo</a>
(JSON)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /v2/lineage/{guid}
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;baseEntityGuid&quot; : &quot;...&quot;,
&quot;guidEntityMap&quot; : {
&quot;property1&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;ACTIVE&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;DELETED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;DEPRECATED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;VALIDATED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;DELETED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
},
&quot;property2&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;ACTIVE&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;PURGED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;DISCOVERED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;DEPRECATED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;DELETED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}
},
&quot;lineageDepth&quot; : 12345,
&quot;lineageDirection&quot; : &quot;INPUT&quot;,
&quot;lineageOnDemandPayload&quot; : {
&quot;property1&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;BOTH&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
},
&quot;property2&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;INPUT&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
}
},
&quot;relations&quot; : [ {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
}, {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
} ],
&quot;relationsOnDemand&quot; : {
&quot;property1&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
},
&quot;property2&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
}
}
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_LineageREST_getLineageGraph_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/lineage/{guid} <a href="../v2/lineage/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Returns lineage info about entity.</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">guid</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
</tr>
</tbody>
</table>
<table class="table resource-request-body">
<caption>Request Body</caption>
<thead>
<tr>
<th>media type</th>
<th>data type</th>
</tr>
</thead>
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference">map of <a href="json_LineageOnDemandConstraints.html">LineageOnDemandConstraints</a>
(JSON)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-codes">
<caption>Response Codes</caption>
<thead>
<tr>
<th>code</th>
<th>condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">If Lineage exists for the given entity</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">Bad query parameters</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">If no lineage is found for the given entity</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response Body</caption>
<thead>
<tr>
<th>media type</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_AtlasLineageInfo.html">AtlasLineageInfo</a>
(JSON)</span></td>
<td><span class="response-description">AtlasLineageInfo</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /v2/lineage/{guid}
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;...&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;INPUT&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
}
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;baseEntityGuid&quot; : &quot;...&quot;,
&quot;guidEntityMap&quot; : {
&quot;property1&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;DELETED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;DELETED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;OBSOLETE&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;OBSOLETE&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;PURGED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
},
&quot;property2&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;DELETED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;DELETED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;DISCOVERED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;DEPRECATED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;PURGED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}
},
&quot;lineageDepth&quot; : 12345,
&quot;lineageDirection&quot; : &quot;OUTPUT&quot;,
&quot;lineageOnDemandPayload&quot; : {
&quot;property1&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;OUTPUT&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
},
&quot;property2&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;BOTH&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
}
},
&quot;relations&quot; : [ {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
}, {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
} ],
&quot;relationsOnDemand&quot; : {
&quot;property1&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
},
&quot;property2&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
}
}
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_LineageREST_getLineageByUniqueAttribute_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/lineage/uniqueAttribute/type/{typeName} <a href="../v2/lineage/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Returns 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</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>default</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">typeName</span></td>
<td>path</td>
<td><span class="parameter-description">- typeName of entity</span></td>
<td><span class="parameter-default-value">&nbsp;</span></td>
<td><span class="parameter-constraints">&nbsp;</span></td>
</tr>
<tr>
<td><span class="parameter-name">depth</span></td>
<td>query</td>
<td><span class="parameter-description">- number of hops for lineage</span></td>
<td><span class="parameter-default-value">3</span></td>
<td><span class="parameter-constraints">int</span></td>
</tr>
<tr>
<td><span class="parameter-name">direction</span></td>
<td>query</td>
<td><span class="parameter-description">- input, output or both</span></td>
<td><span class="parameter-default-value">BOTH</span></td>
<td><span class="parameter-constraints">"BOTH" or "INPUT" or "OUTPUT"</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-codes">
<caption>Response Codes</caption>
<thead>
<tr>
<th>code</th>
<th>condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">If Lineage exists for the given entity</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">Bad query parameters</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">If no lineage is found for the given entity</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response Body</caption>
<thead>
<tr>
<th>media type</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_AtlasLineageInfo.html">AtlasLineageInfo</a>
(JSON)</span></td>
<td><span class="response-description">AtlasLineageInfo</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /v2/lineage/uniqueAttribute/type/{typeName}
Content-Type: application/json;charset=UTF-8
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;baseEntityGuid&quot; : &quot;...&quot;,
&quot;guidEntityMap&quot; : {
&quot;property1&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;ACTIVE&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;PURGED&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;VALIDATED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;OTHER&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;DELETED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
},
&quot;property2&quot; : {
&quot;classificationNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;classifications&quot; : [ {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;ACTIVE&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}, {
&quot;entityGuid&quot; : &quot;...&quot;,
&quot;entityStatus&quot; : &quot;ACTIVE&quot;,
&quot;propagate&quot; : true,
&quot;removePropagationsOnEntityDelete&quot; : true,
&quot;validityPeriods&quot; : [ { }, { } ],
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
} ],
&quot;displayText&quot; : &quot;...&quot;,
&quot;guid&quot; : &quot;...&quot;,
&quot;isIncomplete&quot; : true,
&quot;labels&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meaningNames&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;meanings&quot; : [ {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;OTHER&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
}, {
&quot;confidence&quot; : 12345,
&quot;createdBy&quot; : &quot;...&quot;,
&quot;description&quot; : &quot;...&quot;,
&quot;displayText&quot; : &quot;...&quot;,
&quot;expression&quot; : &quot;...&quot;,
&quot;qualifiedName&quot; : &quot;...&quot;,
&quot;relationGuid&quot; : &quot;...&quot;,
&quot;source&quot; : &quot;...&quot;,
&quot;status&quot; : &quot;PROPOSED&quot;,
&quot;steward&quot; : &quot;...&quot;,
&quot;termGuid&quot; : &quot;...&quot;
} ],
&quot;status&quot; : &quot;DELETED&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;typeName&quot; : &quot;...&quot;
}
},
&quot;lineageDepth&quot; : 12345,
&quot;lineageDirection&quot; : &quot;INPUT&quot;,
&quot;lineageOnDemandPayload&quot; : {
&quot;property1&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;OUTPUT&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
},
&quot;property2&quot; : {
&quot;depth&quot; : 12345,
&quot;direction&quot; : &quot;OUTPUT&quot;,
&quot;inputRelationsLimit&quot; : 12345,
&quot;outputRelationsLimit&quot; : 12345
}
},
&quot;relations&quot; : [ {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
}, {
&quot;fromEntityId&quot; : &quot;...&quot;,
&quot;relationshipId&quot; : &quot;...&quot;,
&quot;toEntityId&quot; : &quot;...&quot;
} ],
&quot;relationsOnDemand&quot; : {
&quot;property1&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
},
&quot;property2&quot; : {
&quot;hasMoreInputs&quot; : true,
&quot;hasMoreOutputs&quot; : true,
&quot;inputRelationsCount&quot; : 12345,
&quot;outputRelationsCount&quot; : 12345
}
}
}
</code>
</pre>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://code.jquery.com/jquery-1.12.2.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>