You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2017/02/18 01:53:46 UTC
[21/27] incubator-atlas-website git commit: Added V2 REST API
documentation (apoorvnaik via mneethiraj)
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/resource_LineageREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_LineageREST.html b/api/v2/resource_LineageREST.html
new file mode 100644
index 0000000..b2a8632
--- /dev/null
+++ b/api/v2/resource_LineageREST.html
@@ -0,0 +1,270 @@
+<!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://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.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">GET /v2/lineage/{guid}</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"> </span></td>
+ <td><span class="parameter-constraints"> </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 "Accept: application/json" 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/{guid}
+Accept: application/json
+
+ </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">
+{
+ "baseEntityGuid" : "...",
+ "guidEntityMap" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ },
+ "relations" : [ {
+ "fromEntityId" : "...",
+ "toEntityId" : "..."
+ }, {
+ "fromEntityId" : "...",
+ "toEntityId" : "..."
+ } ],
+ "lineageDirection" : "OUTPUT",
+ "lineageDepth" : 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://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/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>