http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/ns0_errorBean.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/ns0_errorBean.html b/1.1.0/api/ns0_errorBean.html new file mode 100644 index 0000000..feb179a --- /dev/null +++ b/1.1.0/api/ns0_errorBean.html @@ -0,0 +1,189 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>errorBean</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">errorBean</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="model.html">Data Model</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li> + <a href="ns0.html">ns0</a> > + <ul> + <li><a href="ns0.html">ns0</a></li> + </ul> + </li> + <li class="current"> + <a href="ns0_errorBean.html">errorBean</a> + <ul> + <li><a href="ns0_errorBean.html">errorBean</a></li> + <li><a href="ns0_results.html">results</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>errorBean</h1> + <table> + <tr> + <td align="right">Namespace:</td> + <td>(default namespace)</td> + </tr> + <tr> + <td align="right">XML Schema:</td> + <td><a href="ns0.xsd">ns0.xsd</a></td> + </tr> + </table> + + <h2>XML</h2> + <h3>Elements</h3> + <table> + <tr> + <th>name (type)</th> + <th>min/max<br/>occurs</th> + <th>description</th> + </tr> + <tr> + <td> + status (int) + </td> + <td>1/1</td> + <td> + </td> + </tr> + <tr> + <td> + message (string) + </td> + <td>0/1</td> + <td> + </td> + </tr> + <tr> + <td> + stackTrace (string) + </td> + <td>0/1</td> + <td> + </td> + </tr> + </table> + + <h2>JSON</h2> + <table> + <tr> + <th>property</th> + <th>type</th> + <th>description</th> + </tr> + <tr> + <td>status</td> + <td> + status (int) + </td> + <td> + </td> + </tr> + <tr> + <td>message</td> + <td> + message (string) + </td> + <td> + </td> + </tr> + <tr> + <td>stackTrace</td> + <td> + stackTrace (string) + </td> + <td> + </td> + </tr> + </table> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/ns0_results.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/ns0_results.html b/1.1.0/api/ns0_results.html new file mode 100644 index 0000000..de3e6a9 --- /dev/null +++ b/1.1.0/api/ns0_results.html @@ -0,0 +1,173 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>results</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">results</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="model.html">Data Model</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li> + <a href="ns0.html">ns0</a> > + <ul> + <li><a href="ns0.html">ns0</a></li> + </ul> + </li> + <li class="current"> + <a href="ns0_results.html">results</a> + <ul> + <li><a href="ns0_errorBean.html">errorBean</a></li> + <li><a href="ns0_results.html">results</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>results</h1> + <table> + <tr> + <td align="right">Namespace:</td> + <td>(default namespace)</td> + </tr> + <tr> + <td align="right">XML Schema:</td> + <td><a href="ns0.xsd">ns0.xsd</a></td> + </tr> + </table> + + <h2>XML</h2> + <h3>Elements</h3> + <table> + <tr> + <th>name (type)</th> + <th>min/max<br/>occurs</th> + <th>description</th> + </tr> + <tr> + <td> + href (string) + </td> + <td>0/1</td> + <td> + </td> + </tr> + <tr> + <td> + status (int) + </td> + <td>1/1</td> + <td> + </td> + </tr> + </table> + + <h2>JSON</h2> + <table> + <tr> + <th>property</th> + <th>type</th> + <th>description</th> + </tr> + <tr> + <td>href</td> + <td> + href (string) + </td> + <td> + </td> + </tr> + <tr> + <td>status</td> + <td> + status (int) + </td> + <td> + </td> + </tr> + </table> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_AdminResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_AdminResource.html b/1.1.0/api/resource_AdminResource.html new file mode 100644 index 0000000..5c47766 --- /dev/null +++ b/1.1.0/api/resource_AdminResource.html @@ -0,0 +1,199 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>AdminResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">AdminResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_AdminResource.html">AdminResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>AdminResource</h1> + + <p>Jersey Resource for admin operations.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__admin_session.html">/admin/session</a> + </li> + <li> + <a href="#path__admin_stack.html">/admin/stack</a> + </li> + <li> + <a href="#path__admin_status.html">/admin/status</a> + </li> + <li> + <a href="#path__admin_version.html">/admin/version</a> + </li> + </ul> + <a name="path__admin_session.html"></a> + <h1>/admin/session</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__admin_stack.html"></a> + <h1>/admin/stack</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetches the thread stack dump for this application. + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>text/plain</td> + </tr> + </table> + <p>json representing the thread stack dump.</p> + <a name="path__admin_status.html"></a> + <h1>/admin/status</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__admin_version.html"></a> + <h1>/admin/version</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetches the version for this application. + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>json representing the version.</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_DataSetLineageResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_DataSetLineageResource.html b/1.1.0/api/resource_DataSetLineageResource.html new file mode 100644 index 0000000..90c06ff --- /dev/null +++ b/1.1.0/api/resource_DataSetLineageResource.html @@ -0,0 +1,234 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>DataSetLineageResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">DataSetLineageResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_DataSetLineageResource.html">DataSetLineageResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>DataSetLineageResource</h1> + + <p>Jersey Resource for Hive Table Lineage.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__lineage_hive_table_-tableName-_inputs_graph.html">/lineage/hive/table/{tableName}/inputs/graph</a> + </li> + <li> + <a href="#path__lineage_hive_table_-tableName-_outputs_graph.html">/lineage/hive/table/{tableName}/outputs/graph</a> + </li> + <li> + <a href="#path__lineage_hive_table_-tableName-_schema.html">/lineage/hive/table/{tableName}/schema</a> + </li> + </ul> + <a name="path__lineage_hive_table_-tableName-_inputs_graph.html"></a> + <h1>/lineage/hive/table/{tableName}/inputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the inputs graph for a given entity. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_hive_table_-tableName-_outputs_graph.html"></a> + <h1>/lineage/hive/table/{tableName}/outputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the outputs graph for a given entity. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_hive_table_-tableName-_schema.html"></a> + <h1>/lineage/hive/table/{tableName}/schema</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Return the schema for the given tableName. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>tableName</td> + <td> + table name + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_EntityResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_EntityResource.html b/1.1.0/api/resource_EntityResource.html new file mode 100644 index 0000000..9f6fe16 --- /dev/null +++ b/1.1.0/api/resource_EntityResource.html @@ -0,0 +1,685 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>EntityResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">EntityResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_EntityResource.html">EntityResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>EntityResource</h1> + + <p>Entity management operations as REST API. + +An entity is an "instance" of a Type. Entities conform to the definition +of the Type they correspond with.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__entities.html">/entities</a> + </li> + <li> + <a href="#path__entities_-guid-.html">/entities/{guid}</a> + </li> + <li> + <a href="#path__entities_-guid-_audit.html">/entities/{guid}/audit</a> + </li> + <li> + <a href="#path__entities_-guid-_traitDefinitions.html">/entities/{guid}/traitDefinitions</a> + </li> + <li> + <a href="#path__entities_-guid-_traitDefinitions_-traitName-.html">/entities/{guid}/traitDefinitions/{traitName}</a> + </li> + <li> + <a href="#path__entities_-guid-_traits.html">/entities/{guid}/traits</a> + </li> + <li> + <a href="#path__entities_-guid-_traits_-traitName-.html">/entities/{guid}/traits/{traitName}</a> + </li> + <li> + <a href="#path__entities_qualifiedName.html">/entities/qualifiedName</a> + </li> + </ul> + <a name="path__entities.html"></a> + <h1>/entities</h1> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#POST">POST</a></li> + <li><a href="#PUT">PUT</a></li> + <li><a href="#DELETE">DELETE</a></li> + <li><a href="#GET">GET</a></li> + </ul> + <a name="POST"></a> + <h2>POST</h2> + <p> + Submits the entity definitions (instances). +The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any +unique attribute for the give type. + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="PUT"></a> + <h2>PUT</h2> + <p> + Complete update of a set of entities - the values not specified will be replaced with null/removed +Adds/Updates given entities identified by its GUID or unique attribute + </p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>response payload as json</p> + <a name="DELETE"></a> + <h2>DELETE</h2> + <p> + Delete entities from the repository identified by their guids (including their composite references) +or +Deletes a single entity identified by its type and unique attribute value from the repository (including their composite references) + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + list of deletion candidate guids +or + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>type</td> + <td> + the entity type + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>property</td> + <td> + the unique attribute used to identify the entity + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>value</td> + <td> + the unique attribute value used to identify the entity + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>response payload as json - including guids of entities(including composite references from that entity) that were deleted</p> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>type</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>property</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>value</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-.html"></a> + <h1>/entities/{guid}</h1> + <a name="POST"></a> + <h2>POST</h2> + <p> + Updates entity identified by its GUID +Support Partial update of an entity - Adds/updates any new values specified +Does not support removal of attribute values + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>property</td> + <td> + (no documentation provided) + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetch the complete definition of an entity given its GUID. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + GUID for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_audit.html"></a> + <h1>/entities/{guid}/audit</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the entity audit events for a given entity id. The events are returned in the decreasing order of timestamp. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + entity id + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>startKey</td> + <td> + used for pagination. Startkey is inclusive, the returned results contain the event with the given startkey. +First time getAuditEvents() is called for an entity, startKey should be null, +with count = (number of events required + 1). Next time getAuditEvents() is called for the same entity, +startKey should be equal to the entityKey of the last event returned in the previous call. + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>count</td> + <td> + number of events required + </td> + <td>query</td> + <td>100</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_traitDefinitions.html"></a> + <h1>/entities/{guid}/traitDefinitions</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetches the trait definitions of all the traits associated to the given entity + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_traitDefinitions_-traitName-.html"></a> + <h1>/entities/{guid}/traitDefinitions/{traitName}</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Fetches the trait definition for an entity given its guid and trait name + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>traitName</td> + <td> + name of the trait + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_traits.html"></a> + <h1>/entities/{guid}/traits</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Gets the list of trait names for a given entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>a list of trait names for the given entity guid</p> + <a name="POST"></a> + <h2>POST</h2> + <p> + Adds a new trait to an existing entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_-guid-_traits_-traitName-.html"></a> + <h1>/entities/{guid}/traits/{traitName}</h1> + <a name="DELETE"></a> + <h2>DELETE</h2> + <p> + Deletes a given trait from an existing entity represented by a guid. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + globally unique identifier for the entity + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>traitName</td> + <td> + name of the trait + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__entities_qualifiedName.html"></a> + <h1>/entities/qualifiedName</h1> + <a name="POST"></a> + <h2>POST</h2> + <p> + Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value) +Updates support only partial update of an entity - Adds/updates any new values specified +Updates do not support removal of attribute values + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>type</td> + <td> + the entity type + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>property</td> + <td> + the unique attribute used to identify the entity + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>value</td> + <td> + the unique attributes value + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>response payload as json +The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any +unique attribute for the give type.</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_EntityService.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_EntityService.html b/1.1.0/api/resource_EntityService.html new file mode 100644 index 0000000..d27d205 --- /dev/null +++ b/1.1.0/api/resource_EntityService.html @@ -0,0 +1,376 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>EntityService</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">EntityService</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_EntityService.html">EntityService</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>EntityService</h1> + + <p>Service which handles API requests for v1 entity resources.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__v1_entities.html">/v1/entities</a> + </li> + <li> + <a href="#path__v1_entities_-entityId-.html">/v1/entities/{entityId}</a> + </li> + <li> + <a href="#path__v1_entities_-entityId-_tags.html">/v1/entities/{entityId}/tags</a> + </li> + <li> + <a href="#path__v1_entities_-entityId-_tags_-tag-.html">/v1/entities/{entityId}/tags/{tag}</a> + </li> + </ul> + <a name="path__v1_entities.html"></a> + <h1>/v1/entities</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="POST"></a> + <h2>POST</h2> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__v1_entities_-entityId-.html"></a> + <h1>/v1/entities/{entityId}</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>entityId</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__v1_entities_-entityId-_tags.html"></a> + <h1>/v1/entities/{entityId}/tags</h1> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>entityId</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__v1_entities_-entityId-_tags_-tag-.html"></a> + <h1>/v1/entities/{entityId}/tags/{tag}</h1> + <p> + The following operations are supported on this resource: + </p> + <ul> + <li><a href="#GET">GET</a></li> + <li><a href="#POST">POST</a></li> + <li><a href="#DELETE">DELETE</a></li> + </ul> + <a name="GET"></a> + <h2>GET</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>entityId</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>tag</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="POST"></a> + <h2>POST</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>entityId</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>tag</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Request Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>body</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>*/*<br/>application/xml<br/></td> + </tr> + </table> + <p>(no documentation provided)</p> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="DELETE"></a> + <h2>DELETE</h2> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>entityId</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + <tr> + <td>tag</td> + <td> + (no documentation provided) + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_LineageResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_LineageResource.html b/1.1.0/api/resource_LineageResource.html new file mode 100644 index 0000000..5e3d5af --- /dev/null +++ b/1.1.0/api/resource_LineageResource.html @@ -0,0 +1,234 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>LineageResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">LineageResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_LineageResource.html">LineageResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>LineageResource</h1> + + <p></p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__lineage_-guid-_inputs_graph.html">/lineage/{guid}/inputs/graph</a> + </li> + <li> + <a href="#path__lineage_-guid-_outputs_graph.html">/lineage/{guid}/outputs/graph</a> + </li> + <li> + <a href="#path__lineage_-guid-_schema.html">/lineage/{guid}/schema</a> + </li> + </ul> + <a name="path__lineage_-guid-_inputs_graph.html"></a> + <h1>/lineage/{guid}/inputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns input lineage graph for the given entity id. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + dataset entity id + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_-guid-_outputs_graph.html"></a> + <h1>/lineage/{guid}/outputs/graph</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the outputs graph for a given entity id. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + dataset entity id + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + <a name="path__lineage_-guid-_schema.html"></a> + <h1>/lineage/{guid}/schema</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Returns the schema for the given dataset id. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>guid</td> + <td> + dataset entity id + </td> + <td>path</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>(no documentation provided)</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/ab60d06f/1.1.0/api/resource_MetadataDiscoveryResource.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/resource_MetadataDiscoveryResource.html b/1.1.0/api/resource_MetadataDiscoveryResource.html new file mode 100644 index 0000000..bff0002 --- /dev/null +++ b/1.1.0/api/resource_MetadataDiscoveryResource.html @@ -0,0 +1,324 @@ +<!doctype html> +<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ --> +<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]--> +<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]--> +<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]--> +<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame + Remove this if you use the .htaccess --> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>MetadataDiscoveryResource</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- CSS: implied media="all" --> + <link rel="stylesheet" href="css/style.css?v=2"> + <link rel="stylesheet" href="css/prettify.css"> + + <!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects --> + <script src="js/libs/modernizr-1.7.min.js"></script> + +</head> + +<body class="home"> + + <div class="container"> + <header> + <div id="header" class="column first last span-20"> + <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">MetadataDiscoveryResource</a></div> + <div id="primary" class="column span-18 append-1 prepend-1 first last"> + <ul class="navigation"> + <li id="nav-rest"><a href="rest.html">REST</a></li> + <li id="nav-data"><a href="model.html">Data Model</a></li> + <li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li> + </ul> + </div> + <div> + <ul class="xbreadcrumbs" id="breadcrumbs"> + <li> + <a href="index.html" class="home">Home</a> > + </li> + <li> + <a href="rest.html">REST</a> > + <ul> + <li><a href="model.html">Data Model</a></li> + <li><a href="rest.html">REST</a></li> + <li><a href="downloads.html">Files and Libraries</a></li> + </ul> + </li> + <li class="current"> + <a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a> + <ul> + <li><a href="resource_AdminResource.html">AdminResource</a></li> + <li><a href="resource_DataSetLineageResource.html">DataSetLineageResource</a></li> + <li><a href="resource_EntityResource.html">EntityResource</a></li> + <li><a href="resource_EntityService.html">EntityService</a></li> + <li><a href="resource_LineageResource.html">LineageResource</a></li> + <li><a href="resource_MetadataDiscoveryResource.html">MetadataDiscoveryResource</a></li> + <li><a href="resource_TaxonomyService.html">TaxonomyService</a></li> + <li><a href="resource_TypesResource.html">TypesResource</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div id="main" class="column first last span-20"> + <h1>MetadataDiscoveryResource</h1> + + <p>Jersey Resource for metadata operations.</p> + <p>The following resources are applicable:</p> + <ul> + <li> + <a href="#path__discovery_search.html">/discovery/search</a> + </li> + <li> + <a href="#path__discovery_search_dsl.html">/discovery/search/dsl</a> + </li> + <li> + <a href="#path__discovery_search_fulltext.html">/discovery/search/fulltext</a> + </li> + <li> + <a href="#path__discovery_search_gremlin.html">/discovery/search/gremlin</a> + </li> + </ul> + <a name="path__discovery_search.html"></a> + <h1>/discovery/search</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using a given query. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in DSL format falling back to full text. + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>limit</td> + <td> + number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value + </td> + <td>query</td> + <td>-1</td> + </tr> + <tr> + <td>offset</td> + <td> + offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 + </td> + <td>query</td> + <td>-1</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_dsl.html"></a> + <h1>/discovery/search/dsl</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using query DSL format. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in DSL format. + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>limit</td> + <td> + number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value + </td> + <td>query</td> + <td>-1</td> + </tr> + <tr> + <td>offset</td> + <td> + offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 +Limit and offset in API are used in conjunction with limit and offset in DSL query +Final limit = min(API limit, max(query limit - API offset, 0)) +Final offset = API offset + query offset + </td> + <td>query</td> + <td>-1</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_fulltext.html"></a> + <h1>/discovery/search/fulltext</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using full text search. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query. + </td> + <td>query</td> + <td></td> + </tr> + <tr> + <td>limit</td> + <td> + number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value + </td> + <td>query</td> + <td>-1</td> + </tr> + <tr> + <td>offset</td> + <td> + offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 + </td> + <td>query</td> + <td>-1</td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + <a name="path__discovery_search_gremlin.html"></a> + <h1>/discovery/search/gremlin</h1> + <a name="GET"></a> + <h2>GET</h2> + <p> + Search using raw gremlin query format. + </p> + <h3>Parameters</h3> + <table> + <tr> + <th>name</th> + <th>description</th> + <th>type</th> + <th>default</th> + </tr> + <tr> + <td>query</td> + <td> + search query in raw gremlin format. + </td> + <td>query</td> + <td></td> + </tr> + </table> + <h3>Response Body</h3> + <table> + <tr> + <td align="right">element:</td> + <td>(custom)</td> + </tr> + <tr> + <td align="right">media types:</td> + <td>application/json</td> + </tr> + </table> + <p>JSON representing the type and results.</p> + + <div class="clear" /> + </div> + <footer> + <div id="footer"> + Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>. + </div> + </footer> + </div> <!--! end of #container --> + + <!-- JavaScript at the bottom for fast page loading --> + + <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary --> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script> + <script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script> + + <!--manage the navigation menu--> + <script src="js/libs/xbreadcrumbs.js"></script> + <script> + $(function() { + $('#breadcrumbs').xBreadcrumbs(); + }); + </script> + + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="js/libs/prettify/prettify.js"></script> + <script> + $(function() { + prettyPrint(); + }); + </script> + + <!--[if lt IE 7 ]> + <script src="js/libs/dd_belatedpng.js"></script> + <script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script> + <![endif]--> + +</body> +</html>