You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2017/08/09 16:56:38 UTC
[1/8] atlas-website git commit: Updated with latest V2 API docs
Repository: atlas-website
Updated Branches:
refs/heads/asf-site 2f9c0cbc0 -> f415335a8
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/xml_ns0_PList.html
----------------------------------------------------------------------
diff --git a/api/v2/xml_ns0_PList.html b/api/v2/xml_ns0_PList.html
new file mode 100644
index 0000000..0819f11
--- /dev/null
+++ b/api/v2/xml_ns0_PList.html
@@ -0,0 +1,242 @@
+<!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: PList</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: PList</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 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="syntax_xml.html">XML</a></li>
+ <li class="dropdown"><a href="xml_ns0_PList.html">PList</a></li>
+ </ol>
+
+ <h1 class="page-header">PList <small>Data Type</small></h1>
+
+ <p>Paginated-list, for returning search results.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Namespace</dt>
+ <dd>(Default)</dd>
+ <dt>Schema</dt>
+ <dd><a href="ns0.xsd">ns0.xsd</a></dd>
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>type</th>
+ <th>namespace</th>
+ <th>min/max occurs</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">list</span>
+</td>
+ <td> <span class="datatype-reference">anyType
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/unbounded
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">pageSize</span>
+</td>
+ <td> <span class="datatype-reference">int
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortType</span>
+</td>
+ <td> <span class="datatype-reference"><a href="xml_ns0_sortType.html">sortType</a>
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">startIndex</span>
+</td>
+ <td> <span class="datatype-reference">long
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">totalCount</span>
+</td>
+ <td> <span class="datatype-reference">long
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-xml example"><PList>
+ <list>...</list>
+ <startIndex>...</startIndex>
+ <pageSize>...</pageSize>
+ <totalCount>...</totalCount>
+ <sortType>...</sortType>
+ <sortBy>...</sortBy>
+</PList>
+</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/xml_ns0_atlasClassification.html
----------------------------------------------------------------------
diff --git a/api/v2/xml_ns0_atlasClassification.html b/api/v2/xml_ns0_atlasClassification.html
new file mode 100644
index 0000000..6456c5e
--- /dev/null
+++ b/api/v2/xml_ns0_atlasClassification.html
@@ -0,0 +1,159 @@
+<!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: atlasClassification</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: atlasClassification</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 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="syntax_xml.html">XML</a></li>
+ <li class="dropdown"><a href="xml_ns0_atlasClassification.html">atlasClassification</a></li>
+ </ol>
+
+ <h1 class="page-header">atlasClassification <small>Data Type</small></h1>
+
+ <p>An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Namespace</dt>
+ <dd>(Default)</dd>
+ <dt>Schema</dt>
+ <dd><a href="ns0.xsd">ns0.xsd</a></dd>
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>type</th>
+ <th>namespace</th>
+ <th>min/max occurs</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ </tbody>
+ <tr>
+ <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_atlasStruct.html">atlasStruct</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">attributes</span></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="property-type">element
+</span></td>
+ <td><span class="property-namespaceInfo">
+</span></td>
+ <td><span class="property-minMaxOccurs">0/1
+</span></td>
+ <td><span class="property-description"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">typeName</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-type">element
+</span></td>
+ <td><span class="property-namespaceInfo">
+</span></td>
+ <td><span class="property-minMaxOccurs">0/1
+</span></td>
+ <td><span class="property-description"> </span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-xml example"><atlasClassification>
+ <typeName>...</typeName>
+ <attributes>...</attributes>
+</atlasClassification>
+</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/xml_ns0_atlasStruct.html
----------------------------------------------------------------------
diff --git a/api/v2/xml_ns0_atlasStruct.html b/api/v2/xml_ns0_atlasStruct.html
new file mode 100644
index 0000000..f25e92b
--- /dev/null
+++ b/api/v2/xml_ns0_atlasStruct.html
@@ -0,0 +1,168 @@
+<!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: atlasStruct</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: atlasStruct</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 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="syntax_xml.html">XML</a></li>
+ <li class="dropdown"><a href="xml_ns0_atlasStruct.html">atlasStruct</a></li>
+ </ol>
+
+ <h1 class="page-header">atlasStruct <small>Data Type</small></h1>
+
+ <p>Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Namespace</dt>
+ <dd>(Default)</dd>
+ <dt>Schema</dt>
+ <dd><a href="ns0.xsd">ns0.xsd</a></dd>
+ <dt>Subtypes</dt>
+ <dd><a href="xml_ns0_atlasClassification.html">atlasClassification</a></dd>
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>type</th>
+ <th>namespace</th>
+ <th>min/max occurs</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">attributes</span>
+</td>
+ <td> <span class="datatype-reference">(custom)
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">typeName</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-xml example"><atlasStruct>
+ <typeName>...</typeName>
+ <attributes>...</attributes>
+</atlasStruct>
+</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/xml_ns0_searchFilter.html
----------------------------------------------------------------------
diff --git a/api/v2/xml_ns0_searchFilter.html b/api/v2/xml_ns0_searchFilter.html
new file mode 100644
index 0000000..fbe654c
--- /dev/null
+++ b/api/v2/xml_ns0_searchFilter.html
@@ -0,0 +1,242 @@
+<!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: searchFilter</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: searchFilter</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 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="syntax_xml.html">XML</a></li>
+ <li class="dropdown"><a href="xml_ns0_searchFilter.html">searchFilter</a></li>
+ </ol>
+
+ <h1 class="page-header">searchFilter <small>Data Type</small></h1>
+
+ <p>Generic filter, to specify search criteria using name/value pairs.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Namespace</dt>
+ <dd>(Default)</dd>
+ <dt>Schema</dt>
+ <dd><a href="ns0.xsd">ns0.xsd</a></dd>
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>type</th>
+ <th>namespace</th>
+ <th>min/max occurs</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">getCount</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">maxRows</span>
+</td>
+ <td> <span class="datatype-reference">long
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">params</span>
+</td>
+ <td> <span class="datatype-reference">(custom)
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">sortType</span>
+</td>
+ <td> <span class="datatype-reference"><a href="xml_ns0_sortType.html">sortType</a>
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">0/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">startIndex</span>
+</td>
+ <td> <span class="datatype-reference">long
+</span>
+</td>
+ <td> <span class="property-type">element
+</span>
+</td>
+ <td> <span class="property-namespaceInfo">
+</span>
+</td>
+ <td> <span class="property-minMaxOccurs">1/1
+</span>
+</td>
+ <td> <span class="property-description"> </span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-xml example"><searchFilter>
+ <params>...</params>
+ <startIndex>...</startIndex>
+ <maxRows>...</maxRows>
+ <getCount>...</getCount>
+ <sortBy>...</sortBy>
+ <sortType>...</sortType>
+</searchFilter>
+</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/xml_ns0_sortType.html
----------------------------------------------------------------------
diff --git a/api/v2/xml_ns0_sortType.html b/api/v2/xml_ns0_sortType.html
new file mode 100644
index 0000000..8d42fbb
--- /dev/null
+++ b/api/v2/xml_ns0_sortType.html
@@ -0,0 +1,130 @@
+<!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: sortType</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: sortType</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 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="syntax_xml.html">XML</a></li>
+ <li class="dropdown"><a href="xml_ns0_sortType.html">sortType</a></li>
+ </ol>
+
+ <h1 class="page-header">sortType <small>Data Type</small></h1>
+
+ <p>to specify whether the result should be sorted? If yes, whether asc or desc.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Namespace</dt>
+ <dd>(Default)</dd>
+ <dt>Schema</dt>
+ <dd><a href="ns0.xsd">ns0.xsd</a></dd>
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">NONE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">ASC</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">DESC</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index 0465a9b..f2bd96a 100644
--- a/index.html
+++ b/index.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Data Governance and Metadata framework for Hadoop</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/issue-tracking.html
----------------------------------------------------------------------
diff --git a/issue-tracking.html b/issue-tracking.html
index bbe4a89..6310bec 100644
--- a/issue-tracking.html
+++ b/issue-tracking.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Issue Tracking</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/license.html
----------------------------------------------------------------------
diff --git a/license.html b/license.html
index 9802bb4..c471848 100644
--- a/license.html
+++ b/license.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Project License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/mail-lists.html
----------------------------------------------------------------------
diff --git a/mail-lists.html b/mail-lists.html
index 9f32e25..52ad2ae 100644
--- a/mail-lists.html
+++ b/mail-lists.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/project-info.html
----------------------------------------------------------------------
diff --git a/project-info.html b/project-info.html
index ea21366..b90dbcc 100644
--- a/project-info.html
+++ b/project-info.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/source-repository.html
----------------------------------------------------------------------
diff --git a/source-repository.html b/source-repository.html
index 388f141..92b8778 100644
--- a/source-repository.html
+++ b/source-repository.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Source Repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/team-list.html
----------------------------------------------------------------------
diff --git a/team-list.html b/team-list.html
index f28b321..7315721 100644
--- a/team-list.html
+++ b/team-list.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Team list</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
@@ -271,237 +271,245 @@
<td>Asia/Kolkata</td>
<td><span id="developer-4">Asia/Kolkata</span></td></tr>
<tr class="a">
+<td><a name="amestry"></a>amestry</td>
+<td>Ashutosh Mestry</td>
+<td><a class="externalLink" href="mailto:amestry@apache.org">amestry@apache.org</a></td>
+<td>Hortonworks Inc.</td>
+<td>committer</td>
+<td>America/Los_Angeles</td>
+<td><span id="developer-5">America/Los_Angeles</span></td></tr>
+<tr class="b">
<td><a name="bstortz"></a>bstortz</td>
<td>Barbara Stortz</td>
<td><a class="externalLink" href="mailto:bstortz@sap.com">bstortz@sap.com</a></td>
<td>SAP Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-5">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-6">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="chyzer"></a>chyzer</td>
<td>Chris Hyzer</td>
<td><a class="externalLink" href="mailto:chyzer@aetna.com">chyzer@aetna.com</a></td>
<td>Aetna Inc.</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-6">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-7">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="dmarkwat"></a>dmarkwat</td>
<td>Daniel Markwat</td>
<td><a class="externalLink" href="mailto:dmarkwat@aetna.com">dmarkwat@aetna.com</a></td>
<td>Aetna Inc.</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-7">America/New_York</span></td></tr>
-<tr class="b">
+<td><span id="developer-8">America/New_York</span></td></tr>
+<tr class="a">
<td><a name="darshankumar"></a>darshankumar</td>
<td>Darshan Kumar</td>
<td><a class="externalLink" href="mailto:darshankumar@apache.org">darshankumar@apache.org</a></td>
<td>MPR</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-8">Asia/Kolkata</span></td></tr>
-<tr class="a">
+<td><span id="developer-9">Asia/Kolkata</span></td></tr>
+<tr class="b">
<td><a name="dkantor"></a>dkantor</td>
<td>Dave Kantor</td>
<td><a class="externalLink" href="mailto:dkantor@apache.org">dkantor@apache.org</a></td>
<td>IBM Corporation</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-9">America/New_York</span></td></tr>
-<tr class="b">
+<td><span id="developer-10">America/New_York</span></td></tr>
+<tr class="a">
<td><a name="dkaspar"></a>dkaspar</td>
<td>David Kaspar</td>
<td><a class="externalLink" href="mailto:dkaspar@merck.com">dkaspar@merck.com</a></td>
<td>Merck & Co Inc.</td>
<td>committer, PMC</td>
<td>Europe/Berlin</td>
-<td><span id="developer-10">Europe/Berlin</span></td></tr>
-<tr class="a">
+<td><span id="developer-11">Europe/Berlin</span></td></tr>
+<tr class="b">
<td><a name="dfusaro"></a>dfusaro</td>
<td>Dennis Fusaro</td>
<td><a class="externalLink" href="mailto:dfusaro@aetna.com">dfusaro@aetna.com</a></td>
<td>Aetna Inc.</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-11">America/New_York</span></td></tr>
-<tr class="b">
+<td><span id="developer-12">America/New_York</span></td></tr>
+<tr class="a">
<td><a name="gsenia"></a>gsenia</td>
<td>Greg Senia</td>
<td><a class="externalLink" href="mailto:gsenia@aetna.com">gsenia@aetna.com</a></td>
<td>Aetna Inc.</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-12">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-13">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="rhbutani"></a>rhbutani</td>
<td>Harish Butani</td>
<td><a class="externalLink" href="mailto:rhbutani@apache.org">rhbutani@apache.org</a></td>
<td>-</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-13">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-14">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="yhemanth"></a>yhemanth</td>
<td>Hemanth Yamijala</td>
<td><a class="externalLink" href="mailto:yhemanth@apache.org">yhemanth@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-14">Asia/Kolkata</span></td></tr>
-<tr class="a">
+<td><span id="developer-15">Asia/Kolkata</span></td></tr>
+<tr class="b">
<td><a name="ilasek"></a>ilasek</td>
<td>Ivo Lasek</td>
<td><a class="externalLink" href="mailto:ilasek@merck.com">ilasek@merck.com</a></td>
<td>Merck & Co Inc.</td>
<td>committer, PMC</td>
<td>Europe/Berlin</td>
-<td><span id="developer-15">Europe/Berlin</span></td></tr>
-<tr class="b">
+<td><span id="developer-16">Europe/Berlin</span></td></tr>
+<tr class="a">
<td><a name="jnhagelberg"></a>jnhagelberg</td>
<td>Jeffrey Hagelberg</td>
<td><a class="externalLink" href="mailto:jnhagelberg@apache.org">jnhagelberg@apache.org</a></td>
<td>IBM Corporation</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-16">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-17">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="jitendra"></a>jitendra</td>
<td>Jitendra Pandey</td>
<td><a class="externalLink" href="mailto:jitendra@apache.org">jitendra@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-17">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-18">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="jmaron"></a>jmaron</td>
<td>Jon Maron</td>
<td><a class="externalLink" href="mailto:jmaron@apache.org">jmaron@apache.org</a></td>
<td>-</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-18">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-19">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="kalyanikashikar"></a>kalyanikashikar</td>
<td>Kalyani Kashikar</td>
<td><a class="externalLink" href="mailto:kalyanikashikar@apache.org">kalyanikashikar@apache.org</a></td>
<td>Freestone Infotech</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-19">Asia/Kolkata</span></td></tr>
-<tr class="b">
+<td><span id="developer-20">Asia/Kolkata</span></td></tr>
+<tr class="a">
<td><a name="kbhatt"></a>kbhatt</td>
<td>Keval Bhatt</td>
<td><a class="externalLink" href="mailto:kbhatt@apache.org">kbhatt@apache.org</a></td>
<td>Freestone Infotech</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-20">Asia/Kolkata</span></td></tr>
-<tr class="a">
+<td><span id="developer-21">Asia/Kolkata</span></td></tr>
+<tr class="b">
<td><a name="madhan"></a>madhan</td>
<td>Madhan Neethiraj</td>
<td><a class="externalLink" href="mailto:madhan@apache.org">madhan@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-21">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-22">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="mschussler"></a>mschussler</td>
<td>Mitch Schussler</td>
<td><a class="externalLink" href="mailto:mschussler@apache.org">mschussler@apache.org</a></td>
<td>JPMC</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-22">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-23">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="guptaneeru"></a>guptaneeru</td>
<td>Neeru Gupta</td>
<td><a class="externalLink" href="mailto:guptaneeru@us.ibm.com">guptaneeru@us.ibm.com</a></td>
<td>IBM Corporation</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-23">America/New_York</span></td></tr>
-<tr class="b">
+<td><span id="developer-24">America/New_York</span></td></tr>
+<tr class="a">
<td><a name="nixon"></a>nixon</td>
<td>Nixon Rodrigues</td>
<td><a class="externalLink" href="mailto:nixon@apache.org">nixon@apache.org</a></td>
<td>Freestone Infotech</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-24">Asia/Kolkata</span></td></tr>
-<tr class="a">
+<td><span id="developer-25">Asia/Kolkata</span></td></tr>
+<tr class="b">
<td><a name="sarath"></a>sarath</td>
<td>Sarath Subramanian</td>
<td><a class="externalLink" href="mailto:sarath@apache.org">sarath@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-25">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-26">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="shwethags"></a>shwethags</td>
<td>Shwetha GS</td>
<td><a class="externalLink" href="mailto:shwethags@apache.org">shwethags@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-26">Asia/Kolkata</span></td></tr>
-<tr class="a">
+<td><span id="developer-27">Asia/Kolkata</span></td></tr>
+<tr class="b">
<td><a name="sriksun"></a>sriksun</td>
<td>Srikanth Sundarrajan</td>
<td><a class="externalLink" href="mailto:sriksun@apache.org">sriksun@apache.org</a></td>
<td>InMobi</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-27">Asia/Kolkata</span></td></tr>
-<tr class="b">
+<td><span id="developer-28">Asia/Kolkata</span></td></tr>
+<tr class="a">
<td><a name="sumasai"></a>sumasai</td>
<td>Suma Shivaprasad</td>
<td><a class="externalLink" href="mailto:sumasai@apache.org">sumasai@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-28">America/Los_Angeles</span></td></tr>
-<tr class="a">
+<td><span id="developer-29">America/Los_Angeles</span></td></tr>
+<tr class="b">
<td><a name="ssuresh"></a>ssuresh</td>
<td>Suresh Srinivas</td>
<td><a class="externalLink" href="mailto:ssuresh@apache.org">ssuresh@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-29">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-30">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="tbeerbower"></a>tbeerbower</td>
<td>Tom Beerbower</td>
<td><a class="externalLink" href="mailto:tbeerbower@apache.org">tbeerbower@apache.org</a></td>
<td>-</td>
<td>committer, PMC</td>
<td>America/New_York</td>
-<td><span id="developer-30">America/New_York</span></td></tr>
-<tr class="a">
+<td><span id="developer-31">America/New_York</span></td></tr>
+<tr class="b">
<td><a name="vranganathan"></a>vranganathan</td>
<td>Venkat Ranganathan</td>
<td><a class="externalLink" href="mailto:venkatrangan@apache.org">venkatrangan@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-31">America/Los_Angeles</span></td></tr>
-<tr class="b">
+<td><span id="developer-32">America/Los_Angeles</span></td></tr>
+<tr class="a">
<td><a name="venkatesh"></a>venkatesh</td>
<td>Venkatesh Seetharam</td>
<td><a class="externalLink" href="mailto:venkatesh@apache.org">venkatesh@apache.org</a></td>
<td>-</td>
<td>committer, PMC</td>
<td>America/Los_Angeles</td>
-<td><span id="developer-32">America/Los_Angeles</span></td></tr>
-<tr class="a">
+<td><span id="developer-33">America/Los_Angeles</span></td></tr>
+<tr class="b">
<td><a name="svimal2106"></a>svimal2106</td>
<td>Vimal Sharma</td>
<td><a class="externalLink" href="mailto:svimal2106@apache.org">svimal2106@apache.org</a></td>
<td>Hortonworks Inc.</td>
<td>committer, PMC</td>
<td>Asia/Kolkata</td>
-<td><span id="developer-33">Asia/Kolkata</span></td></tr></table></div>
+<td><span id="developer-34">Asia/Kolkata</span></td></tr></table></div>
<div class="section">
<h3><a name="Contributors"></a>Contributors</h3><a name="Contributors"></a>
<p>There are no contributors listed for this project. Please check back again later.</p><script type="text/javascript">
@@ -522,34 +530,35 @@ function init(){
offsetDate('developer-3', '-8');
offsetDate('developer-4', '5');
offsetDate('developer-5', '-8');
- offsetDate('developer-6', '-5');
+ offsetDate('developer-6', '-8');
offsetDate('developer-7', '-5');
- offsetDate('developer-8', '5');
- offsetDate('developer-9', '-5');
- offsetDate('developer-10', '1');
- offsetDate('developer-11', '-5');
+ offsetDate('developer-8', '-5');
+ offsetDate('developer-9', '5');
+ offsetDate('developer-10', '-5');
+ offsetDate('developer-11', '1');
offsetDate('developer-12', '-5');
- offsetDate('developer-13', '-8');
- offsetDate('developer-14', '5');
- offsetDate('developer-15', '1');
- offsetDate('developer-16', '-5');
- offsetDate('developer-17', '-8');
- offsetDate('developer-18', '-5');
- offsetDate('developer-19', '5');
+ offsetDate('developer-13', '-5');
+ offsetDate('developer-14', '-8');
+ offsetDate('developer-15', '5');
+ offsetDate('developer-16', '1');
+ offsetDate('developer-17', '-5');
+ offsetDate('developer-18', '-8');
+ offsetDate('developer-19', '-5');
offsetDate('developer-20', '5');
- offsetDate('developer-21', '-8');
- offsetDate('developer-22', '-5');
+ offsetDate('developer-21', '5');
+ offsetDate('developer-22', '-8');
offsetDate('developer-23', '-5');
- offsetDate('developer-24', '5');
- offsetDate('developer-25', '-8');
- offsetDate('developer-26', '5');
+ offsetDate('developer-24', '-5');
+ offsetDate('developer-25', '5');
+ offsetDate('developer-26', '-8');
offsetDate('developer-27', '5');
- offsetDate('developer-28', '-8');
+ offsetDate('developer-28', '5');
offsetDate('developer-29', '-8');
- offsetDate('developer-30', '-5');
- offsetDate('developer-31', '-8');
+ offsetDate('developer-30', '-8');
+ offsetDate('developer-31', '-5');
offsetDate('developer-32', '-8');
- offsetDate('developer-33', '5');
+ offsetDate('developer-33', '-8');
+ offsetDate('developer-34', '5');
}
window.onLoad = init();
[5/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_DiscoveryREST.html b/api/v2/resource_DiscoveryREST.html
index 63e4875..345313a 100644
--- a/api/v2/resource_DiscoveryREST.html
+++ b/api/v2/resource_DiscoveryREST.html
@@ -50,7 +50,9 @@
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
+ <li><a href="#resource_DiscoveryREST_searchUsingAttribute_GET">GET /v2/search/attribute</a></li>
<li><a href="#resource_DiscoveryREST_searchUsingBasic_GET">GET /v2/search/basic</a></li>
+ <li><a href="#resource_DiscoveryREST_searchWithParameters_POST">POST /v2/search/basic</a></li>
<li><a href="#resource_DiscoveryREST_searchUsingDSL_GET">GET /v2/search/dsl</a></li>
<li><a href="#resource_DiscoveryREST_searchUsingFullText_GET">GET /v2/search/fulltext</a></li>
<li class="divider"></li>
@@ -69,6 +71,225 @@
<p>REST interface for data discovery using dsl or full text search</p>
+ <div id="resource_DiscoveryREST_searchUsingAttribute_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/attribute <a href="../v2/search/attribute" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Retrieve data for the specified attribute search query</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ <th>constraints</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">attrName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">Attribute name</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">attrValuePrefix</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">Attibute value to search on</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">limit</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">offset</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">typeName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
+ <td><span class="parameter-constraints"> </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">On successful FullText lookup with some results, might return an empty list if execution succeeded
+without any results</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">400</span></td>
+ <td><span class="response-condition">Invalid wildcard or query parameters</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_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+ <td><span class="response-description">Search results</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/search/attribute
+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">
+{
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GT",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "LIKE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_DiscoveryREST_searchUsingBasic_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -92,6 +313,12 @@
<td><span class="parameter-constraints"> </span></td>
</tr>
<tr>
+ <td><span class="parameter-name">excludeDeletedEntities</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-constraints">boolean</span></td>
+ </tr>
+ <tr>
<td><span class="parameter-name">limit</span></td>
<td>query</td>
<td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
@@ -178,12 +405,35 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
"queryType" : "BASIC",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -222,6 +472,31 @@ Content-Type: application/json
}, {
"entity" : {
"guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
"status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
@@ -230,9 +505,227 @@ Content-Type: application/json
"property1" : { },
"property2" : { }
}
+ }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_searchWithParameters_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Attribute based search for entities satisfying the search parameters</p>
+
+ <table class="table resource-request-body">
+ <caption>Request 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a>
+ (JSON)</span></td>
+ <td><span class="request-description">Search parameters</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">On successful search</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">400</span></td>
+ <td><span class="response-condition">Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name</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_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+ <td><span class="response-description">Atlas search result</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/search/basic
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+}
+ </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">
+{
+ "queryType" : "DSL",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
},
"score" : 12345.0
- } ]
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
</code>
</pre>
@@ -349,7 +842,30 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "queryType" : "DSL",
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
@@ -365,7 +881,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -381,7 +897,7 @@ Content-Type: application/json
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -404,7 +920,31 @@ Content-Type: application/json
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
</code>
</pre>
@@ -430,6 +970,12 @@ Content-Type: application/json
</thead>
<tbody>
<tr>
+ <td><span class="parameter-name">excludeDeletedEntities</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-constraints">boolean</span></td>
+ </tr>
+ <tr>
<td><span class="parameter-name">limit</span></td>
<td>query</td>
<td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
@@ -509,7 +1055,30 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "queryType" : "BASIC",
+ "queryType" : "ATTRIBUTE",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "LTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "LTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
@@ -525,7 +1094,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -541,7 +1110,7 @@ Content-Type: application/json
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -564,7 +1133,31 @@ Content-Type: application/json
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
</code>
</pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_EntityREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_EntityREST.html b/api/v2/resource_EntityREST.html
index 6d72790..3c6460c 100644
--- a/api/v2/resource_EntityREST.html
+++ b/api/v2/resource_EntityREST.html
@@ -60,6 +60,7 @@
<li><a href="#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT">PUT /v2/entity/guid/{guid}</a></li>
<li><a href="#resource_EntityREST_getClassifications_GET"><abbr title="GET /v2/entity/guid/{guid}/classifications">GET /v2/entity/guid/{guid}/cla...</abbr></a></li>
<li><a href="#resource_EntityREST_addClassifications_POST"><abbr title="POST /v2/entity/guid/{guid}/classifications">POST /v2/entity/guid/{guid}/cl...</abbr></a></li>
+ <li><a href="#resource_EntityREST_updateClassification_PUT"><abbr title="PUT /v2/entity/guid/{guid}/classifications">PUT /v2/entity/guid/{guid}/cla...</abbr></a></li>
<li><a href="#resource_EntityREST_deleteByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}">DELETE /v2/entity/uniqueAttrib...</abbr></a></li>
<li><a href="#resource_EntityREST_getByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}">GET /v2/entity/uniqueAttribute...</abbr></a></li>
<li><a href="#resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}">PUT /v2/entity/uniqueAttribute...</abbr></a></li>
@@ -137,12 +138,16 @@ Accept: application/json
{
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -171,6 +176,10 @@ Accept: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -192,12 +201,16 @@ Accept: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -254,7 +267,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -264,7 +277,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -290,7 +303,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -311,7 +324,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -375,7 +388,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -477,7 +490,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -488,7 +501,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -524,7 +537,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -545,7 +558,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -556,7 +569,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -566,7 +579,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -577,7 +590,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -609,7 +622,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -620,7 +633,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -700,12 +713,16 @@ Content-Type: application/json
{
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -726,12 +743,16 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -754,12 +775,16 @@ Content-Type: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -781,12 +806,16 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -869,12 +898,16 @@ Accept: application/json
{
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -901,6 +934,10 @@ Accept: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -923,12 +960,16 @@ Accept: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -950,12 +991,16 @@ Accept: application/json
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -991,7 +1036,7 @@ Content-Type: application/json
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1001,7 +1046,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1022,7 +1067,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1038,7 +1083,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1080,7 +1125,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1090,7 +1135,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1101,7 +1146,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1111,7 +1156,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1122,7 +1167,7 @@ Content-Type: application/json
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1291,7 +1336,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1312,7 +1357,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1328,7 +1373,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1338,7 +1383,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1349,7 +1394,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1359,7 +1404,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1370,7 +1415,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1380,7 +1425,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1391,7 +1436,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1434,7 +1479,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1520,6 +1565,10 @@ Content-Type: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -1542,12 +1591,16 @@ Content-Type: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -1569,12 +1622,16 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -1704,7 +1761,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1741,7 +1798,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1751,7 +1808,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1772,7 +1829,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1783,7 +1840,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1804,7 +1861,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1814,7 +1871,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1836,7 +1893,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1847,7 +1904,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2010,6 +2067,82 @@ HTTP/1.1 201 Created
</div>
</div>
+ <div id="resource_EntityREST_updateClassification_PUT">
+ <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Updates classifications to an existing entity represented by a guid.</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">globally unique identifier for the entity</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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a>
+ (JSON)</span></td>
+ </tr>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
+ <td><span class="datatype-reference">list of <a href="xml_ns0_atlasClassification.html">atlasClassification</a>
+ (XML)</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>
+PUT /v2/entity/guid/{guid}/classifications
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+} ]
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 204 No Content
+
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_EntityREST_deleteByUniqueAttribute_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -2074,7 +2207,7 @@ Content-Type: application/json
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2084,7 +2217,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2095,7 +2228,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2142,7 +2275,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2173,7 +2306,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2194,7 +2327,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2216,7 +2349,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2313,6 +2446,10 @@ Content-Type: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2335,12 +2472,16 @@ Content-Type: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2368,6 +2509,10 @@ Content-Type: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2475,6 +2620,10 @@ Accept: application/json
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2497,12 +2646,16 @@ Accept: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2524,12 +2677,16 @@ Accept: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -2586,7 +2743,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2596,7 +2753,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2622,7 +2779,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2633,7 +2790,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2664,7 +2821,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2675,7 +2832,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2696,7 +2853,7 @@ Content-Type: application/json
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2718,7 +2875,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_LineageREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_LineageREST.html b/api/v2/resource_LineageREST.html
index 1360880..5d0da52 100644
--- a/api/v2/resource_LineageREST.html
+++ b/api/v2/resource_LineageREST.html
@@ -174,7 +174,7 @@ Content-Type: application/json
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -185,7 +185,7 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -202,7 +202,7 @@ Content-Type: application/json
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "OUTPUT",
+ "lineageDirection" : "BOTH",
"lineageDepth" : 12345
}
</code>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_RelationshipREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_RelationshipREST.html b/api/v2/resource_RelationshipREST.html
new file mode 100644
index 0000000..026e7d7
--- /dev/null
+++ b/api/v2/resource_RelationshipREST.html
@@ -0,0 +1,502 @@
+<!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: RelationshipREST</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: RelationshipREST</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_RelationshipREST_create_POST">POST /v2/relationship</a></li>
+ <li><a href="#resource_RelationshipREST_update_PUT">PUT /v2/relationship</a></li>
+ <li><a href="#resource_RelationshipREST_deleteById_DELETE"><abbr title="DELETE /v2/relationship/guid/{guid}">DELETE /v2/relationship/guid/{...</abbr></a></li>
+ <li><a href="#resource_RelationshipREST_getById_GET"><abbr title="GET /v2/relationship/guid/{guid}">GET /v2/relationship/guid/{gui...</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_RelationshipREST.html">RelationshipREST</a></li>
+ </ol>
+
+ <h1 class="page-header">RelationshipREST <small>Resource</small></h1>
+
+ <p>REST interface for entity relationships.</p>
+
+ <div id="resource_RelationshipREST_create_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Create a new relationship between entities.</p>
+
+ <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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a>
+ (JSON)</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>
+ </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_AtlasRelationship.html">AtlasRelationship</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>
+POST /v2/relationship
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_RelationshipREST_update_PUT">
+ <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Update an existing relationship between entities.</p>
+
+ <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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a>
+ (JSON)</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>
+ </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_AtlasRelationship.html">AtlasRelationship</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>
+PUT /v2/relationship
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 204 No Content
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_RelationshipREST_deleteById_DELETE">
+ <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Delete a relationship between entities using guid.</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>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+DELETE /v2/relationship/guid/{guid}
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 204 No Content
+
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_RelationshipREST_getById_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Get relationship information between entities using guid.</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-response-body">
+ <caption>Response 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 "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_AtlasRelationship.html">AtlasRelationship</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/relationship/guid/{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">
+{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}
+ </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>
[8/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
Updated with latest V2 API docs
Project: http://git-wip-us.apache.org/repos/asf/atlas-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/atlas-website/commit/f415335a
Tree: http://git-wip-us.apache.org/repos/asf/atlas-website/tree/f415335a
Diff: http://git-wip-us.apache.org/repos/asf/atlas-website/diff/f415335a
Branch: refs/heads/asf-site
Commit: f415335a8a47dd94c360bc8f13d4c813321e8d74
Parents: 2f9c0cb
Author: apoorvnaik <ap...@apache.org>
Authored: Wed Aug 9 09:56:24 2017 -0700
Committer: apoorvnaik <ap...@apache.org>
Committed: Wed Aug 9 09:56:24 2017 -0700
----------------------------------------------------------------------
Architecture.html | 8 +-
Authentication-Authorization.html | 8 +-
Bridge-Falcon.html | 8 +-
Bridge-Hive.html | 8 +-
Bridge-Sqoop.html | 8 +-
Configuration.html | 8 +-
EclipseSetup.html | 8 +-
Export-API.html | 8 +-
Export-HDFS-API.html | 8 +-
HighAvailability.html | 8 +-
Import-API-Options.html | 8 +-
Import-API.html | 17 +-
Import-Export-API.html | 8 +-
InstallationSteps.html | 8 +-
Notification-Entity.html | 8 +-
QuickStart.html | 8 +-
Repository.html | 8 +-
Search.html | 220 +-
Security.html | 8 +-
StormAtlasHook.html | 8 +-
TypeSystem.html | 8 +-
api/v2/application.wadl | 157 +
api/v2/data.html | 216 +-
api/v2/index.html | 238 +-
api/v2/json_AtlasAttributeDef.html | 12 +-
api/v2/json_AtlasBaseTypeDef.html | 6 +-
api/v2/json_AtlasClassificationDef.html | 8 +-
api/v2/json_AtlasConstraintDef.html | 2 +-
api/v2/json_AtlasEntitiesWithExtInfo.html | 22 +-
api/v2/json_AtlasEntity.html | 17 +-
api/v2/json_AtlasEntityDef.html | 8 +-
api/v2/json_AtlasEntityExtInfo.html | 12 +-
api/v2/json_AtlasEntityHeader.html | 2 +-
api/v2/json_AtlasEntityWithExtInfo.html | 18 +-
api/v2/json_AtlasEnumDef.html | 4 +-
api/v2/json_AtlasEnumElementDef.html | 2 +-
api/v2/json_AtlasFullTextResult.html | 2 +-
api/v2/json_AtlasLineageInfo.html | 8 +-
api/v2/json_AtlasObjectId.html | 42 +-
api/v2/json_AtlasQueryType.html | 6 +-
api/v2/json_AtlasRelationship.html | 256 +
api/v2/json_AtlasRelationshipDef.html | 350 +
api/v2/json_AtlasRelationshipEndDef.html | 171 +
api/v2/json_AtlasSearchResult.html | 75 +-
api/v2/json_AtlasStruct.html | 4 +-
api/v2/json_AtlasStructDef.html | 12 +-
api/v2/json_AtlasTypeDefHeader.html | 4 +-
api/v2/json_AtlasTypesDef.html | 160 +-
api/v2/json_AttributeSearchResult.html | 2 +-
api/v2/json_Cardinality.html | 2 +-
api/v2/json_ClassificationAssociateRequest.html | 2 +-
api/v2/json_Condition.html | 122 +
api/v2/json_EntityMutationResponse.html | 16 +-
api/v2/json_EntityOperation.html | 2 +-
api/v2/json_FilterCriteria.html | 182 +
api/v2/json_LineageDirection.html | 2 +-
api/v2/json_LineageRelation.html | 2 +-
api/v2/json_Operator.html | 160 +
api/v2/json_PList.html | 2 +-
api/v2/json_PropagateTags.html | 143 +
api/v2/json_RelationshipCategory.html | 132 +
api/v2/json_SearchParameters.html | 222 +
api/v2/json_SortType.html | 2 +-
api/v2/json_Status.html | 2 +-
api/v2/json_Status_AtlasRelationship.html | 122 +
api/v2/json_TypeCategory.html | 6 +-
api/v2/ns0.xsd | 530 --
api/v2/resource_DiscoveryREST.html | 613 +-
api/v2/resource_EntityREST.html | 299 +-
api/v2/resource_LineageREST.html | 6 +-
api/v2/resource_RelationshipREST.html | 502 ++
api/v2/resource_TypesREST.html | 1552 ++++-
api/v2/resources.html | 22 +-
api/v2/syntax_json.html | 171 +-
api/v2/syntax_xml.html | 170 -
api/v2/ui/swagger.json | 6122 +++++++++++++-----
api/v2/xml_ns0_PList.html | 242 +
api/v2/xml_ns0_atlasClassification.html | 159 +
api/v2/xml_ns0_atlasStruct.html | 168 +
api/v2/xml_ns0_searchFilter.html | 242 +
api/v2/xml_ns0_sortType.html | 130 +
index.html | 8 +-
issue-tracking.html | 8 +-
license.html | 8 +-
mail-lists.html | 8 +-
project-info.html | 8 +-
source-repository.html | 8 +-
team-list.html | 173 +-
88 files changed, 11481 insertions(+), 2994 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Architecture.html
----------------------------------------------------------------------
diff --git a/Architecture.html b/Architecture.html
index 9abd154..44de9e4 100644
--- a/Architecture.html
+++ b/Architecture.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Architecture</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Authentication-Authorization.html
----------------------------------------------------------------------
diff --git a/Authentication-Authorization.html b/Authentication-Authorization.html
index 7638fdd..6a46097 100644
--- a/Authentication-Authorization.html
+++ b/Authentication-Authorization.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Authentication & Authorization in Apache Atlas.</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Falcon.html
----------------------------------------------------------------------
diff --git a/Bridge-Falcon.html b/Bridge-Falcon.html
index c53baa2..4bb8a0e 100644
--- a/Bridge-Falcon.html
+++ b/Bridge-Falcon.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Falcon Atlas Bridge</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Hive.html
----------------------------------------------------------------------
diff --git a/Bridge-Hive.html b/Bridge-Hive.html
index 19d1ae1..e43aed9 100644
--- a/Bridge-Hive.html
+++ b/Bridge-Hive.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Hive Atlas Bridge</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Bridge-Sqoop.html
----------------------------------------------------------------------
diff --git a/Bridge-Sqoop.html b/Bridge-Sqoop.html
index d51307e..79b5eee 100644
--- a/Bridge-Sqoop.html
+++ b/Bridge-Sqoop.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Sqoop Atlas Bridge</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Configuration.html
----------------------------------------------------------------------
diff --git a/Configuration.html b/Configuration.html
index e422549..ff75f66 100644
--- a/Configuration.html
+++ b/Configuration.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Configuring Apache Atlas - Application Properties</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/EclipseSetup.html
----------------------------------------------------------------------
diff --git a/EclipseSetup.html b/EclipseSetup.html
index 3e58608..406804c 100644
--- a/EclipseSetup.html
+++ b/EclipseSetup.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Tools required to build and run Apache Atlas on Eclipse</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Export-API.html
----------------------------------------------------------------------
diff --git a/Export-API.html b/Export-API.html
index 75221cc..d8c3917 100644
--- a/Export-API.html
+++ b/Export-API.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Export API</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Export-HDFS-API.html
----------------------------------------------------------------------
diff --git a/Export-HDFS-API.html b/Export-HDFS-API.html
index 41b8e51..831f505 100644
--- a/Export-HDFS-API.html
+++ b/Export-HDFS-API.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Export & Import APIs for HDFS Path</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/HighAvailability.html
----------------------------------------------------------------------
diff --git a/HighAvailability.html b/HighAvailability.html
index b20622a..f56ca1a 100644
--- a/HighAvailability.html
+++ b/HighAvailability.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Fault Tolerance and High Availability Options</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-API-Options.html
----------------------------------------------------------------------
diff --git a/Import-API-Options.html b/Import-API-Options.html
index fb4db49..beb6b38 100644
--- a/Import-API-Options.html
+++ b/Import-API-Options.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Import API Options</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-API.html
----------------------------------------------------------------------
diff --git a/Import-API.html b/Import-API.html
index 6680fc3..4ab24fe 100644
--- a/Import-API.html
+++ b/Import-API.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Import API</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
@@ -322,6 +322,15 @@ curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data
"http://localhost:21000/api/atlas/admin/import"
</pre></div>
+<p>The <i>request</i> parameter is optional. If import has to be run without any options use:</p>
+<div class="source">
+<pre>
+curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data"
+ -H "Cache-Control: no-cache"
+ -F data=@quickStartDB.zip
+ "http://localhost:21000/api/atlas/admin/import"
+
+</pre></div>
<p>The call below performs Import of <i>QuickStart</i> database using a ZIP file available on server.</p>
<div class="source">
<pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Import-Export-API.html
----------------------------------------------------------------------
diff --git a/Import-Export-API.html b/Import-Export-API.html
index 639d3b7..d337d21 100644
--- a/Import-Export-API.html
+++ b/Import-Export-API.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Export & Import REST APIs</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/InstallationSteps.html
----------------------------------------------------------------------
diff --git a/InstallationSteps.html b/InstallationSteps.html
index 09fd512..71bdec4 100644
--- a/InstallationSteps.html
+++ b/InstallationSteps.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Building & Installing Apache Atlas</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Notification-Entity.html
----------------------------------------------------------------------
diff --git a/Notification-Entity.html b/Notification-Entity.html
index c8c4deb..0316601 100644
--- a/Notification-Entity.html
+++ b/Notification-Entity.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Entity Change Notifications</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/QuickStart.html
----------------------------------------------------------------------
diff --git a/QuickStart.html b/QuickStart.html
index f597052..612e079 100644
--- a/QuickStart.html
+++ b/QuickStart.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Quick Start Guide</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Repository.html
----------------------------------------------------------------------
diff --git a/Repository.html b/Repository.html
index 9e220bb..f5bcbf5 100644
--- a/Repository.html
+++ b/Repository.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Search.html
----------------------------------------------------------------------
diff --git a/Search.html b/Search.html
index 39bbc80..0c11db9 100644
--- a/Search.html
+++ b/Search.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Search</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
@@ -218,10 +218,182 @@
<h2><a name="Search"></a>Search</h2>
<p>Atlas exposes search over the metadata in two ways:</p>
<ul>
-<li>Search using DSL</li>
-<li>Full-text search</li></ul></div>
+<li>Basic Search</li>
+<li>Advanced Search (DSL or Full-Text)</li></ul></div>
<div class="section">
-<h3><a name="Search_DSL_Grammar"></a>Search DSL Grammar</h3>
+<h3><a name="Basic_search"></a>Basic search</h3>
+<p>The basic search allows you to query using typename of an entity, associated classification/tag and has support for filtering on the entity attribute(s) as well as the classification/tag attributes.</p>
+<p>The entire query structure can be represented using the following JSON structure (called SearchParameters)</p>
+<div class="source">
+<pre>
+{
+ "typeName": "hive_table",
+ "excludeDeletedEntities": true,
+ "classification" : "",
+ "query": "",
+ "limit": 25,
+ "offset": 0,
+ "entityFilters": {
+ "attributeName": "name",
+ "operator": "contains",
+ "attributeValue": "testtable"
+ },
+ "tagFilters": null,
+ "attributes": [""]
+}
+
+</pre></div>
+<p><b><i>Field description</i></b></p>
+<p></p>
+<ul>
+<li>typeName: The type of entity to look for</li>
+<li>excludeDeletedEntities: Should the search include deleted entities too (default: true)</li>
+<li>classification: Only include entities with given Classification/tag</li>
+<li>query: Any free text occurrence that the entity should have (generic/wildcard queries might be slow)</li>
+<li>limit: Max number of results to fetch</li>
+<li>offset: Starting offset of the result set (useful for pagination)</li>
+<li>entityFilters: Entity Attribute filter(s)</li>
+<li>tagFilters: Classification/tag Attribute filter(s)</li>
+<li>attributes: Attributes to include in the search result (default: include any attribute present in the filter)</li></ul>
+<p>Attribute based filtering can be done on multiple attributes with AND/OR condition.</p>
+<p><b>NOTE: The tagFilters and entityFilters field have same JSON structure.</b></p>
+<p><b><i>Examples of filtering (for hive_table attributes)</i></b></p>
+<ul>
+<li>Single attribute</li></ul>
+<div class="source">
+<pre>
+ {
+ "typeName": "hive_table",
+ "excludeDeletedEntities": true,
+ "classification" : "",
+ "query": "",
+ "limit": 50,
+ "offset": 0,
+ "entityFilters": {
+ "attributeName": "name",
+ "operator": "contains",
+ "attributeValue": "testtable"
+ },
+ "tagFilters": null,
+ "attributes": [""]
+ }
+
+</pre></div>
+<p></p>
+<ul>
+<li>Multi-attribute with OR</li></ul>
+<div class="source">
+<pre>
+ {
+ "typeName": "hive_table",
+ "excludeDeletedEntities": true,
+ "classification" : "",
+ "query": "",
+ "limit": 50,
+ "offset": 0,
+ "entityFilters": {
+ "condition": "OR",
+ "criterion": [
+ {
+ "attributeName": "name",
+ "operator": "contains",
+ "attributeValue": "testtable"
+ },
+ {
+ "attributeName": "owner",
+ "operator": "eq",
+ "attributeValue": "admin"
+ }
+ ]
+ },
+ "tagFilters": null,
+ "attributes": [""]
+ }
+
+</pre></div>
+<p></p>
+<ul>
+<li>Multi-attribute with AND</li></ul>
+<div class="source">
+<pre>
+ {
+ "typeName": "hive_table",
+ "excludeDeletedEntities": true,
+ "classification" : "",
+ "query": "",
+ "limit": 50,
+ "offset": 0,
+ "entityFilters": {
+ "condition": "AND",
+ "criterion": [
+ {
+ "attributeName": "name",
+ "operator": "contains",
+ "attributeValue": "testtable"
+ },
+ {
+ "attributeName": "owner",
+ "operator": "eq",
+ "attributeValue": "admin"
+ }
+ ]
+ },
+ "tagFilters": null,
+ "attributes": [""]
+ }
+
+</pre></div>
+<p><b><i>Supported operators for filtering</i></b></p>
+<p></p>
+<ul>
+<li>LT (symbols: <, lt) works with Numeric, Date attributes</li>
+<li>GT (symbols: >, gt) works with Numeric, Date attributes</li>
+<li>LTE (symbols: <=, lte) works with Numeric, Date attributes</li>
+<li>GTE (symbols: >=, gte) works with Numeric, Date attributes</li>
+<li>EQ (symbols: eq, =) works with Numeric, Date, String attributes</li>
+<li>NEQ (symbols: neq, !=) works with Numeric, Date, String attributes</li>
+<li>LIKE (symbols: like, LIKE) works with String attributes</li>
+<li>STARTS_WITH (symbols: startsWith, STARTSWITH) works with String attributes</li>
+<li>ENDS_WITH (symbols: endsWith, ENDSWITH) works with String attributes</li>
+<li>CONTAINS (symbols: contains, CONTAINS) works with String attributes</li></ul>
+<p><b><i>CURL Samples</i></b></p>
+<div class="source">
+<pre>
+ curl -sivk -g
+ -u <user>:<password>
+ -X POST
+ -d '{
+ "typeName": "hive_table",
+ "excludeDeletedEntities": true,
+ "classification" : "",
+ "query": "",
+ "limit": 50,
+ "offset": 0,
+ "entityFilters": {
+ "condition": "AND",
+ "criterion": [
+ {
+ "attributeName": "name",
+ "operator": "contains",
+ "attributeValue": "testtable"
+ },
+ {
+ "attributeName": "owner",
+ "operator": "eq",
+ "attributeValue": "admin"
+ }
+ ]
+ },
+ "tagFilters": null,
+ "attributes": [""]
+ }'
+ <protocol>://<atlas_host>:<atlas_port>/api/atlas/v2/search/basic
+
+</pre></div></div>
+<div class="section">
+<h3><a name="Advanced_Search"></a>Advanced Search</h3></div>
+<div class="section">
+<h4><a name="Search_DSL_Grammar"></a>Search DSL Grammar</h4>
<p>The DSL exposes an SQL like query language for searching the metadata based on the type system. The grammar for the DSL is below.</p>
<div class="source">
<pre>
@@ -232,9 +404,9 @@ query: querySrc ~ opt(loopExpression) ~ opt(groupByExpr) ~ opt(selectClause) ~ o
querySrc: rep1sep(singleQrySrc, opt(COMMA))
singleQrySrc = FROM ~ fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression) |
- WHERE ~ (expr ^? notIdExpression) |
- expr ^? notIdExpression |
- fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression)
+ WHERE ~ (expr ^? notIdExpression) |
+ expr ^? notIdExpression |
+ fromSrc ~ opt(WHERE) ~ opt(expr ^? notIdExpression)
fromSrc: identifier ~ AS ~ alias | identifier
@@ -267,10 +439,10 @@ expr: compE ~ opt(rep(exprRight))
exprRight: (AND | OR) ~ compE
compE:
- arithE ~ (LT | LTE | EQ | NEQ | GT | GTE) ~ arithE |
- arithE ~ (ISA | IS) ~ ident |
- arithE ~ HAS ~ ident |
- arithE | countClause | maxClause | minClause | sumClause
+ arithE ~ (LT | LTE | EQ | NEQ | GT | GTE) ~ arithE |
+ arithE ~ (ISA | IS) ~ ident |
+ arithE ~ HAS ~ ident |
+ arithE | countClause | maxClause | minClause | sumClause
arithE: multiE ~ opt(rep(arithERight))
@@ -287,14 +459,14 @@ identifier: rep1sep(ident, DOT)
alias: ident | stringLit
literal: booleanConstant |
- intConstant |
- longConstant |
- floatConstant |
- doubleConstant |
- stringLit
+ intConstant |
+ longConstant |
+ floatConstant |
+ doubleConstant |
+ stringLit
</pre></div>
-<p>Grammar language: {noformat} opt(a) => a is optional ~ => a combinator. 'a ~ b' means a followed by b rep => zero or more rep1sep => one or more, separated by second arg. {noformat}</p>
+<p>Grammar language: {noformat} opt(a) => a is optional ~ => a combinator. 'a ~ b' means a followed by b rep => zero or more rep1sep => one or more, separated by second arg. {noformat}</p>
<p>Language Notes:</p>
<ul>
<li>A <b>SingleQuery</b> expression can be used to search for entities of a <i>Trait</i> or <i>Class</i>.</li></ul>Entities can be filtered based on a 'Where Clause' and Entity Attributes can be retrieved based on a 'Select Clause'.
@@ -310,13 +482,11 @@ literal: booleanConstant |
<li>ORDERBY is optional. When order by clause is specified, case insensitive sorting is done based on the column specified.</li></ul>For sorting in descending order specify 'DESC' after order by clause. If no order by is specified, then no default sorting is applied.
<ul>
<li>LIMIT is optional. It limits the maximum number of objects to be fetched starting from specified optional offset. If no offset is specified count starts from beginning.</li>
-<li>There are couple of Predicate functions different from SQL:
+<li>There are couple of Predicate functions different from SQL:</li></ul>* <i>is</i> or <i>isa</i>can be used to filter Entities that have a particular Trait. * <i>has</i> can be used to filter Entities that have a value for a particular Attribute.
<ul>
-<li><i>is</i> or <i>isa</i>can be used to filter Entities that have a particular Trait.</li>
-<li><i>has</i> can be used to filter Entities that have a value for a particular Attribute.</li></ul></li>
<li>Any identifiers or constants with special characters(space,$,",{,}) should be enclosed within backquote (`)</li></ul></div>
<div class="section">
-<h4><a name="DSL_Examples"></a>DSL Examples</h4>
+<h5><a name="DSL_Examples"></a>DSL Examples</h5>
<p>For the model, Asset - attributes name, owner, description DB - supertype Asset - attributes clusterName, parameters, comment Column - extends Asset - attributes type, comment Table - supertype Asset - db, columns, parameters, comment Traits - PII, Log Data</p>
<p>DSL queries: * from DB</p>
<ul>
@@ -337,7 +507,7 @@ literal: booleanConstant |
<li>from Person select count() as 'count', max(Person.age) as 'max', min(Person.age)</li>
<li>`Log Data`</li></ul></div>
<div class="section">
-<h3><a name="Full-text_Search"></a>Full-text Search</h3>
+<h4><a name="Full-text_Search"></a>Full-text Search</h4>
<p>Atlas also exposes a lucene style full-text search capability.</p></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/Security.html
----------------------------------------------------------------------
diff --git a/Security.html b/Security.html
index 8a62041..e56df02 100644
--- a/Security.html
+++ b/Security.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Security Features of Apache Atlas</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/StormAtlasHook.html
----------------------------------------------------------------------
diff --git a/StormAtlasHook.html b/StormAtlasHook.html
index c09107b..ec82362 100644
--- a/StormAtlasHook.html
+++ b/StormAtlasHook.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Storm Atlas Bridge</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/TypeSystem.html
----------------------------------------------------------------------
diff --git a/TypeSystem.html b/TypeSystem.html
index eadfc65..820532d 100644
--- a/TypeSystem.html
+++ b/TypeSystem.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-24
+ | Generated by Apache Maven Doxia at 2017-08-09
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170724" />
+ <meta name="Date-Revision-yyyymmdd" content="20170809" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Atlas – Type System</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -204,8 +204,8 @@
- <li id="publishDate" class="pull-right">Last Published: 2017-07-24</li> <li class="divider pull-right">|</li>
- <li id="projectVersion" class="pull-right">Version: 0.8.1-SNAPSHOT</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-08-09</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9-SNAPSHOT</li>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/application.wadl
----------------------------------------------------------------------
diff --git a/api/v2/application.wadl b/api/v2/application.wadl
index 35a0d1c..e1002ae 100644
--- a/api/v2/application.wadl
+++ b/api/v2/application.wadl
@@ -5,6 +5,7 @@
<wadl:doc xmlns:enunciate="http://enunciate.webcohesion.com/" enunciate:generatedBy="Enunciate-2.0"/>
<wadl:grammars>
+ <wadl:include href="ns0.xsd"/>
</wadl:grammars>
<wadl:resources base="./">
@@ -24,6 +25,32 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</wadl:method>
</wadl:resource>
+ <wadl:resource path="v2/relationship">
+ <wadl:method name="POST">
+ <wadl:doc><![CDATA[Create a new relationship between entities.]]></wadl:doc>
+ <wadl:request>
+ <wadl:representation mediaType="application/json">
+ </wadl:representation>
+ </wadl:request>
+ <wadl:response>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ </wadl:resource>
+
+ <wadl:resource path="v2/relationship">
+ <wadl:method name="PUT">
+ <wadl:doc><![CDATA[Update an existing relationship between entities.]]></wadl:doc>
+ <wadl:request>
+ <wadl:representation mediaType="application/json">
+ </wadl:representation>
+ </wadl:request>
+ <wadl:response>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ </wadl:resource>
+
<wadl:resource path="v2/entity/bulk">
<wadl:method name="GET">
<wadl:doc><![CDATA[Bulk API to retrieve list of entities identified by its GUIDs.]]></wadl:doc>
@@ -93,6 +120,36 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</wadl:param>
</wadl:resource>
+ <wadl:resource path="v2/search/attribute">
+ <wadl:method name="GET">
+ <wadl:doc><![CDATA[Retrieve data for the specified attribute search query]]></wadl:doc>
+ <wadl:request>
+ <wadl:param name="attrName" style="query">
+ <wadl:doc><![CDATA[Attribute name]]></wadl:doc>
+ </wadl:param>
+ <wadl:param name="attrValuePrefix" style="query">
+ <wadl:doc><![CDATA[Attibute value to search on]]></wadl:doc>
+ </wadl:param>
+ <wadl:param name="limit" style="query">
+ <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc>
+ </wadl:param>
+ <wadl:param name="offset" style="query">
+ <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc>
+ </wadl:param>
+ <wadl:param name="typeName" style="query">
+ <wadl:doc><![CDATA[limit the result to only entities of specified type or its sub-types]]></wadl:doc>
+ </wadl:param>
+ </wadl:request>
+ <wadl:response status="400">
+ <wadl:doc><![CDATA[Invalid wildcard or query parameters]]></wadl:doc>
+ </wadl:response>
+ <wadl:response status="200">
+ <wadl:doc><![CDATA[Search results]]></wadl:doc>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ </wadl:resource>
+
<wadl:resource path="v2/search/basic">
<wadl:method name="GET">
<wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc>
@@ -100,6 +157,9 @@ Existing entity is matched using its unique guid if supplied or by its unique at
<wadl:param name="classification" style="query">
<wadl:doc><![CDATA[limit the result to only entities tagged with the given classification or or its sub-types]]></wadl:doc>
</wadl:param>
+ <wadl:param name="excludeDeletedEntities" style="query">
+ <wadl:doc><![CDATA[]]></wadl:doc>
+ </wadl:param>
<wadl:param name="limit" style="query">
<wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc>
</wadl:param>
@@ -123,6 +183,24 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</wadl:method>
</wadl:resource>
+ <wadl:resource path="v2/search/basic">
+ <wadl:method name="POST">
+ <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc>
+ <wadl:request>
+ <wadl:doc><![CDATA[Search parameters]]></wadl:doc>
+ <wadl:representation mediaType="application/json">
+ </wadl:representation>
+ </wadl:request>
+ <wadl:response status="400">
+ <wadl:doc><![CDATA[Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name]]></wadl:doc>
+ </wadl:response>
+ <wadl:response status="200">
+ <wadl:doc><![CDATA[Atlas search result]]></wadl:doc>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ </wadl:resource>
+
<wadl:resource path="v2/search/dsl">
<wadl:method name="GET">
<wadl:doc><![CDATA[Retrieve data for the specified DSL]]></wadl:doc>
@@ -157,6 +235,9 @@ Existing entity is matched using its unique guid if supplied or by its unique at
<wadl:method name="GET">
<wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc>
<wadl:request>
+ <wadl:param name="excludeDeletedEntities" style="query">
+ <wadl:doc><![CDATA[]]></wadl:doc>
+ </wadl:param>
<wadl:param name="limit" style="query">
<wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc>
</wadl:param>
@@ -301,6 +382,31 @@ Null updates are not possible]]></wadl:doc>
</wadl:param>
</wadl:resource>
+ <wadl:resource path="v2/relationship/guid/{guid}">
+ <wadl:method name="GET">
+ <wadl:doc><![CDATA[Get relationship information between entities using guid.]]></wadl:doc>
+ <wadl:request>
+ </wadl:request>
+ <wadl:response>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ <wadl:param name="guid" style="template">
+ <wadl:doc><![CDATA[]]></wadl:doc>
+ </wadl:param>
+ </wadl:resource>
+
+ <wadl:resource path="v2/relationship/guid/{guid}">
+ <wadl:method name="DELETE">
+ <wadl:doc><![CDATA[Delete a relationship between entities using guid.]]></wadl:doc>
+ <wadl:request>
+ </wadl:request>
+ </wadl:method>
+ <wadl:param name="guid" style="template">
+ <wadl:doc><![CDATA[]]></wadl:doc>
+ </wadl:param>
+ </wadl:resource>
+
<wadl:resource path="v2/types/typedefs/headers">
<wadl:method name="GET">
<wadl:doc><![CDATA[Bulk retrieval API for all type definitions returned as a list of minimal information header]]></wadl:doc>
@@ -339,6 +445,21 @@ Null updates are not possible]]></wadl:doc>
</wadl:param>
</wadl:resource>
+ <wadl:resource path="v2/entity/guid/{guid}/classifications">
+ <wadl:method name="PUT">
+ <wadl:doc><![CDATA[Updates classifications to an existing entity represented by a guid.]]></wadl:doc>
+ <wadl:request>
+ <wadl:representation mediaType="application/json">
+ </wadl:representation>
+ <wadl:representation mediaType="application/xml" element="atlasClassification">
+ </wadl:representation>
+ </wadl:request>
+ </wadl:method>
+ <wadl:param name="guid" style="template">
+ <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc>
+ </wadl:param>
+ </wadl:resource>
+
<wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}">
<wadl:method name="GET">
<wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute.]]></wadl:doc>
@@ -495,6 +616,42 @@ Null updates are not possible]]></wadl:doc>
</wadl:param>
</wadl:resource>
+ <wadl:resource path="v2/types/relationshipdef/guid/{guid}">
+ <wadl:method name="GET">
+ <wadl:doc><![CDATA[Get the relationship definition for the given guid]]></wadl:doc>
+ <wadl:request>
+ </wadl:request>
+ <wadl:response status="404">
+ <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc>
+ </wadl:response>
+ <wadl:response status="200">
+ <wadl:doc><![CDATA[relationship definition]]></wadl:doc>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ <wadl:param name="guid" style="template">
+ <wadl:doc><![CDATA[relationship guid]]></wadl:doc>
+ </wadl:param>
+ </wadl:resource>
+
+ <wadl:resource path="v2/types/relationshipdef/name/{name}">
+ <wadl:method name="GET">
+ <wadl:doc><![CDATA[Get the relationship definition by it's name (unique)]]></wadl:doc>
+ <wadl:request>
+ </wadl:request>
+ <wadl:response status="404">
+ <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc>
+ </wadl:response>
+ <wadl:response status="200">
+ <wadl:doc><![CDATA[relationship definition]]></wadl:doc>
+ <wadl:representation mediaType="application/json"/>
+ </wadl:response>
+ </wadl:method>
+ <wadl:param name="name" style="template">
+ <wadl:doc><![CDATA[relationship name]]></wadl:doc>
+ </wadl:param>
+ </wadl:resource>
+
<wadl:resource path="v2/types/structdef/guid/{guid}">
<wadl:method name="GET">
<wadl:doc><![CDATA[Get the struct definition for the given guid]]></wadl:doc>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/data.html
----------------------------------------------------------------------
diff --git a/api/v2/data.html b/api/v2/data.html
index c61a827..38aa078 100644
--- a/api/v2/data.html
+++ b/api/v2/data.html
@@ -51,6 +51,7 @@
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li><a href="#syntax_json">JSON</a></li>
+ <li><a href="#syntax_xml">XML</a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -77,13 +78,13 @@
<tr class="clickable-row" data-href="json_AtlasAttributeDef.html">
<td> <span class="datatype-name">AtlasAttributeDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-attribute.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html">
<td> <span class="datatype-name">AtlasBaseTypeDef</span>
</td>
- <td> <span class="datatype-description">Common-attributes for all Atlas types.</span>
+ <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassification.html">
@@ -95,7 +96,7 @@
<tr class="clickable-row" data-href="json_AtlasClassificationDef.html">
<td> <span class="datatype-name">AtlasClassificationDef</span>
</td>
- <td> <span class="datatype-description">Details of a classification-type.</span>
+ <td> <span class="datatype-description">class that captures details of a classification-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassifications.html">
@@ -107,31 +108,31 @@
<tr class="clickable-row" data-href="json_AtlasConstraintDef.html">
<td> <span class="datatype-name">AtlasConstraintDef</span>
</td>
- <td> <span class="datatype-description">Details of a constraint.</span>
+ <td> <span class="datatype-description">class that captures details of a constraint.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span>
</td>
- <td> <span class="datatype-description">List of Atlas entity along with the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntity.html">
<td> <span class="datatype-name">AtlasEntity</span>
</td>
- <td> <span class="datatype-description">Atlas entity representation</span>
+ <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityDef.html">
<td> <span class="datatype-name">AtlasEntityDef</span>
</td>
- <td> <span class="datatype-description">Details of an entity-type.</span>
+ <td> <span class="datatype-description">class that captures details of a entity-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html">
<td> <span class="datatype-name">AtlasEntityExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity representation along with extended info which included the entities being referred to</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityHeader.html">
@@ -143,109 +144,179 @@
<tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntityWithExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity with information about the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumDef.html">
<td> <span class="datatype-name">AtlasEnumDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-type.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumElementDef.html">
<td> <span class="datatype-name">AtlasEnumElementDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-element.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-element.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasFullTextResult.html">
<td> <span class="datatype-name">AtlasFullTextResult</span>
</td>
- <td> <span class="datatype-description">Search results for FullText APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasLineageInfo.html">
<td> <span class="datatype-name">AtlasLineageInfo</span>
</td>
- <td> <span class="datatype-description">Lineage information for a single entity</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasObjectId.html">
+ <td> <span class="datatype-name">AtlasObjectId</span>
+</td>
+ <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasQueryType.html">
<td> <span class="datatype-name">AtlasQueryType</span>
</td>
- <td> <span class="datatype-description">Various querying mechanisms supported by Atlas</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationship.html">
+ <td> <span class="datatype-name">AtlasRelationship</span>
+</td>
+ <td> <span class="datatype-description">Atlas relationship instance.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipDef</span>
+</td>
+ <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipEndDef</span>
+</td>
+ <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasSearchResult.html">
<td> <span class="datatype-name">AtlasSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results of the Discovery APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStruct.html">
<td> <span class="datatype-name">AtlasStruct</span>
</td>
- <td> <span class="datatype-description">Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStructDef.html">
<td> <span class="datatype-name">AtlasStructDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-type.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html">
<td> <span class="datatype-name">AtlasTypeDefHeader</span>
</td>
- <td> <span class="datatype-description">Minimal set of information about a type definition</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypesDef.html">
<td> <span class="datatype-name">AtlasTypesDef</span>
</td>
- <td> <span class="datatype-description">A collection of atlas enum, struct, classification and entity definitions (models).</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AttributeSearchResult.html">
<td> <span class="datatype-name">AttributeSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results for attribute(s)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Cardinality.html">
<td> <span class="datatype-name">Cardinality</span>
</td>
- <td> <span class="datatype-description">Cardinality of an attribute i.e. single-valued or multi-valued.</span>
+ <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html">
<td> <span class="datatype-name">ClassificationAssociateRequest</span>
</td>
- <td> <span class="datatype-description">Tag association request for a list of entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Condition.html">
+ <td> <span class="datatype-name">Condition</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityMutationResponse.html">
<td> <span class="datatype-name">EntityMutationResponse</span>
</td>
- <td> <span class="datatype-description">Entity modification response. Contains entity headers for each successful modification (create/update/delete)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityOperation.html">
<td> <span class="datatype-name">EntityOperation</span>
</td>
- <td> <span class="datatype-description">Entity operations supported by Atlas via REST</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_FilterCriteria.html">
+ <td> <span class="datatype-name">FilterCriteria</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageDirection.html">
<td> <span class="datatype-name">LineageDirection</span>
</td>
- <td> <span class="datatype-description">Lineage direction</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageRelation.html">
<td> <span class="datatype-name">LineageRelation</span>
</td>
- <td> <span class="datatype-description">Lineage relation between two entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Operator.html">
+ <td> <span class="datatype-name">Operator</span>
+</td>
+ <td> <span class="datatype-description">Supported search operations
+Logical comparision operators can only be used with numbers or dates
+IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PList.html">
@@ -254,22 +325,109 @@
<td> <span class="datatype-description">Paginated-list, for returning search results.</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="json_PropagateTags.html">
+ <td> <span class="datatype-name">PropagateTags</span>
+</td>
+ <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance.
+Tags can propagate:
+NONE - not at all
+ONE_TO_TWO - from end 1 to 2
+TWO_TO_ONE - from end 2 to 1
+BOTH - both ways
+
+Care needs to be taken when specifying. The use cases we are aware of where this flag is useful:
+
+- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here
+- propagating classifications around Glossary synonyms - BOTH could be used here.
+
+There is an expectation that further enhancements will allow more granular control of tag propagation and will
+address how to resolve conflicts.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_RelationshipCategory.html">
+ <td> <span class="datatype-name">RelationshipCategory</span>
+</td>
+ <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle.
+UML terminology is used for the values.
+ASSOCIATION is a relationship with no containment.
+COMPOSITION and AGGREGATION are containment relationships.
+The difference being in the lifecycles of the container and its children. In the COMPOSITION case,
+the children cannot exist without the container. For AGGREGATION, the life cycles
+of the container and children are totally independant.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_SearchParameters.html">
+ <td> <span class="datatype-name">SearchParameters</span>
+</td>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="json_SortType.html">
<td> <span class="datatype-name">SortType</span>
</td>
- <td> <span class="datatype-description">Type of sorting to be applied on the result set, defaults to NONE</span>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Status.html">
<td> <span class="datatype-name">Status</span>
</td>
- <td> <span class="datatype-description">Status of the entity - can be active or deleted.</span>
+ <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html">
+ <td> <span class="datatype-name">Status</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_TypeCategory.html">
<td> <span class="datatype-name">TypeCategory</span>
</td>
- <td> <span class="datatype-description">Category of a defined type</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <h3 id="syntax_xml">XML</h3>
+
+ <table class="table table-hover data-types">
+ <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption>
+ <thead>
+ <tr>
+ <th align="center">type</th>
+ <th align="center">description</th>
+ </tr>
+ </thead>
+ <tbody data-link="row" class="rowlink">
+ <tr class="clickable-row" data-href="xml_ns0_PList.html">
+ <td> <span class="datatype-name">PList</span>
+</td>
+ <td> <span class="datatype-description">Paginated-list, for returning search results.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_searchFilter.html">
+ <td> <span class="datatype-name">searchFilter</span>
+</td>
+ <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_sortType.html">
+ <td> <span class="datatype-name">sortType</span>
+</td>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html">
+ <td> <span class="datatype-name">atlasClassification</span>
+</td>
+ <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html">
+ <td> <span class="datatype-name">atlasStruct</span>
+</td>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
</tbody>
[2/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/ui/swagger.json
----------------------------------------------------------------------
diff --git a/api/v2/ui/swagger.json b/api/v2/ui/swagger.json
index 901b864..2715dbb 100644
--- a/api/v2/ui/swagger.json
+++ b/api/v2/ui/swagger.json
@@ -6,11 +6,9 @@
"url" : "http://www.apache.org/licenses/LICENSE-2.0.txt",
"name" : "The Apache Software License, Version 2.0"
},
- "version" : "0.9-incubating-SNAPSHOT",
+ "version" : "0.9-SNAPSHOT",
"title" : "Atlas REST API"
},
- "host" : "localhost:21000",
- "basePath" : "/api/atlas/",
"schemes" : [],
"tags" : [
{
@@ -32,6 +30,12 @@
}
,
{
+ "name" : "RelationshipREST"
+ ,
+ "description" : "REST interface for entity relationships."
+ }
+ ,
+ {
"name" : "TypesREST"
,
"description" : "REST interface for CRUD operations on type definitions."
@@ -74,6 +78,10 @@
"description" : "",
"type" : "boolean"
},
+ "defaultValue" : {
+"description" : "",
+"type" : "string"
+ },
"constraints" : {
"description" : "",
"type" : "array",
@@ -91,6 +99,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -105,7 +114,7 @@
}
} ]
},
- "description" : "Details of a struct-attribute."
+ "description" : "class that captures details of a struct-attribute."
}
,
"json_AtlasBaseTypeDef" : {
@@ -161,7 +170,7 @@
}
},
"example" : {
- "category" : "MAP",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -176,7 +185,7 @@
"property2" : "..."
}
},
- "description" : "Common-attributes for all Atlas types."
+ "description" : "Base class that captures common-attributes for all Atlas types."
}
,
"json_AtlasClassification" : {
@@ -224,11 +233,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -251,6 +261,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -265,7 +276,7 @@
}
} ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -280,7 +291,7 @@
"property2" : "..."
}
},
- "description" : "Details of a classification-type."
+ "description" : "class that captures details of a classification-type."
}
,
"json_AtlasClassifications" : {
@@ -298,7 +309,7 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "NONE",
+ "sortType" : "DESC",
"sortBy" : "..."
},
"description" : "REST serialization friendly list."
@@ -327,7 +338,7 @@
"property2" : { }
}
},
- "description" : "Details of a constraint."
+ "description" : "class that captures details of a constraint."
}
,
"json_AtlasEntitiesWithExtInfo" : {
@@ -352,12 +363,16 @@
"example" : {
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -384,6 +399,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -412,6 +431,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -433,12 +456,16 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -460,7 +487,7 @@
}
}
},
- "description" : "List of Atlas entity along with the referred entities"
+ "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
}
,
"json_AtlasEntity" : {
@@ -500,6 +527,13 @@
"description" : "",
"type" : "number"
},
+ "relationshipAttributes" : {
+"description" : "",
+"type" : "object",
+"additionalProperties" : {
+ "type" : "object"
+}
+ },
"classifications" : {
"description" : "",
"type" : "array",
@@ -518,6 +552,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -537,7 +575,7 @@
"property2" : { }
}
},
- "description" : "Atlas entity representation"
+ "description" : "An instance of an entity - like hive_table, hive_database."
}
,
"json_AtlasEntityDef" : {
@@ -570,6 +608,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -587,11 +626,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -606,7 +646,7 @@
}
} ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -621,7 +661,7 @@
"property2" : "..."
}
},
- "description" : "Details of an entity-type."
+ "description" : "class that captures details of a entity-type."
}
,
"json_AtlasEntityExtInfo" : {
@@ -640,12 +680,16 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -673,6 +717,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -694,7 +742,7 @@
}
}
},
- "description" : "Entity representation along with extended info which included the entities being referred to"
+ "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
}
,
"json_AtlasEntityHeader" : {
@@ -767,6 +815,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -795,6 +847,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -816,12 +872,16 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -843,7 +903,7 @@
}
}
},
- "description" : "Entity with information about the referred entities"
+ "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
}
,
"json_AtlasEnumDef" : {
@@ -880,7 +940,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENTITY",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -895,7 +955,7 @@
"property2" : "..."
}
},
- "description" : "Details of an enum-type."
+ "description" : "class that captures details of an enum-type."
}
,
"json_AtlasEnumElementDef" : {
@@ -920,7 +980,7 @@
"description" : "...",
"ordinal" : 12345
},
- "description" : "Details of an enum-element."
+ "description" : "class that captures details of an enum-element."
}
,
"json_AtlasFullTextResult" : {
@@ -939,7 +999,7 @@
"example" : {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -950,7 +1010,7 @@
},
"score" : 12345.0
},
- "description" : "Search results for FullText APIs"
+ "description" : ""
}
,
"json_AtlasLineageInfo" : {
@@ -1000,7 +1060,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1017,10 +1077,41 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "OUTPUT",
+ "lineageDirection" : "BOTH",
"lineageDepth" : 12345
},
- "description" : "Lineage information for a single entity"
+ "description" : ""
+ }
+ ,
+ "json_AtlasObjectId" : {
+ "type" : "object",
+ "title" : "AtlasObjectId",
+ "properties" : {
+ "guid" : {
+"description" : "",
+"type" : "string"
+ },
+ "typeName" : {
+"description" : "",
+"type" : "string"
+ },
+ "uniqueAttributes" : {
+"description" : "",
+"type" : "object",
+"additionalProperties" : {
+ "type" : "object"
+}
+ }
+ },
+ "example" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Reference to an object-instance of an Atlas type - like entity."
}
,
"json_AtlasQueryType" : {
@@ -1030,166 +1121,158 @@
"DSL",
"FULL_TEXT",
"GREMLIN",
- "BASIC"
+ "BASIC",
+ "ATTRIBUTE"
],
- "description" : "Various querying mechanisms supported by Atlas"
+ "description" : ""
}
,
- "json_AtlasSearchResult" : {
+ "json_AtlasRelationship" : {
"type" : "object",
- "title" : "AtlasSearchResult",
+ "title" : "AtlasRelationship",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
"properties" : {
- "queryType" : {
+ "guid" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasQueryType"
+"type" : "string"
},
- "queryText" : {
+ "status" : {
"description" : "",
-"type" : "string"
+"$ref" : "#/definitions/json_Status_AtlasRelationship"
},
- "type" : {
+ "createdBy" : {
"description" : "",
"type" : "string"
},
- "classification" : {
+ "updatedBy" : {
"description" : "",
"type" : "string"
},
- "entities" : {
+ "createTime" : {
"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasEntityHeader"
-}
+"type" : "number"
},
- "attributes" : {
+ "updateTime" : {
"description" : "",
-"$ref" : "#/definitions/json_AttributeSearchResult"
+"type" : "number"
},
- "fullTextResult" : {
+ "version" : {
"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasFullTextResult"
-}
+"type" : "number"
+ },
+ "end1" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "end2" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "label" : {
+"description" : "",
+"type" : "string"
}
- },
+ }
+ }
+ ],
"example" : {
- "queryType" : "DSL",
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
"guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "attributes" : {
+ "uniqueAttributes" : {
"property1" : { },
"property2" : { }
}
- }, {
+ },
+ "end2" : {
"guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "attributes" : {
+ "uniqueAttributes" : {
"property1" : { },
"property2" : { }
}
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
},
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ]
-},
- "description" : "Search results of the Discovery APIs"
- }
- ,
- "json_AtlasStruct" : {
- "type" : "object",
- "title" : "AtlasStruct",
- "properties" : {
- "typeName" : {
-"description" : "",
-"type" : "string"
- },
- "attributes" : {
-"description" : "",
-"type" : "object",
-"additionalProperties" : {
- "type" : "object"
-}
- }
- },
- "example" : {
+ "label" : "...",
"typeName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
}
},
- "description" : "Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
+ "description" : "Atlas relationship instance."
}
,
- "json_AtlasStructDef" : {
+ "json_AtlasRelationshipDef" : {
"type" : "object",
- "title" : "AtlasStructDef",
+ "title" : "AtlasRelationshipDef",
"allOf" : [
{
- "$ref" : "#/definitions/json_AtlasBaseTypeDef"
+ "$ref" : "#/definitions/json_AtlasStructDef"
},
{
"properties" : {
- "attributeDefs" : {
+ "relationshipCategory" : {
"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasAttributeDef"
-}
+"$ref" : "#/definitions/json_RelationshipCategory"
+ },
+ "propagateTags" : {
+"description" : "",
+"$ref" : "#/definitions/json_PropagateTags"
+ },
+ "endDef1" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasRelationshipEndDef"
+ },
+ "endDef2" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasRelationshipEndDef"
+ },
+ "relationshipLabel" : {
+"description" : "",
+"type" : "string"
}
}
}
],
"example" : {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
"attributeDefs" : [ {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -1207,11 +1290,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -1226,7 +1310,7 @@
}
} ]
} ],
- "category" : "STRUCT",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1241,14 +1325,14 @@
"property2" : "..."
}
},
- "description" : "Details of a struct-type."
+ "description" : "AtlasRelationshipDef is a TypeDef that defines a relationship.\n\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required\nRelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.\n\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n\nRelationshipDefs introduce new atributes to the entity instances. For example\nEntityDef A might hav
e attributes attr1,attr2,attr3\nEntityDef B might have attributes attr4,attr5,attr6\nRelationshipDef AtoB might define 2 ends\nend1: type A, name attr7\nend1: type B, name attr8\n\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances"
}
,
- "json_AtlasTypeDefHeader" : {
+ "json_AtlasRelationshipEndDef" : {
"type" : "object",
- "title" : "AtlasTypeDefHeader",
+ "title" : "AtlasRelationshipEndDef",
"properties" : {
- "guid" : {
+ "type" : {
"description" : "",
"type" : "string"
},
@@ -1256,204 +1340,379 @@
"description" : "",
"type" : "string"
},
- "category" : {
+ "isContainer" : {
"description" : "",
-"$ref" : "#/definitions/json_TypeCategory"
+"type" : "boolean"
+ },
+ "cardinality" : {
+"description" : "",
+"$ref" : "#/definitions/json_Cardinality"
+ },
+ "isLegacyAttribute" : {
+"description" : "",
+"type" : "boolean"
}
},
"example" : {
- "guid" : "...",
+ "type" : "...",
"name" : "...",
- "category" : "ARRAY"
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
},
- "description" : "Minimal set of information about a type definition"
+ "description" : "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship."
}
,
- "json_AtlasTypesDef" : {
+ "json_AtlasSearchResult" : {
"type" : "object",
- "title" : "AtlasTypesDef",
+ "title" : "AtlasSearchResult",
"properties" : {
- "enumDefs" : {
+ "queryType" : {
"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasEnumDef"
-}
+"$ref" : "#/definitions/json_AtlasQueryType"
},
- "structDefs" : {
+ "searchParameters" : {
"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasStructDef"
-}
+"$ref" : "#/definitions/json_SearchParameters"
},
- "classificationDefs" : {
+ "queryText" : {
+"description" : "",
+"type" : "string"
+ },
+ "type" : {
+"description" : "",
+"type" : "string"
+ },
+ "classification" : {
+"description" : "",
+"type" : "string"
+ },
+ "entities" : {
"description" : "",
"type" : "array",
"items" : {
- "$ref" : "#/definitions/json_AtlasClassificationDef"
+ "$ref" : "#/definitions/json_AtlasEntityHeader"
}
},
- "entityDefs" : {
+ "attributes" : {
+"description" : "",
+"$ref" : "#/definitions/json_AttributeSearchResult"
+ },
+ "fullTextResult" : {
"description" : "",
"type" : "array",
"items" : {
- "$ref" : "#/definitions/json_AtlasEntityDef"
+ "$ref" : "#/definitions/json_AtlasFullTextResult"
}
},
- "empty" : {
+ "referredEntities" : {
"description" : "",
-"type" : "boolean"
+"type" : "object",
+"additionalProperties" : {
+ "$ref" : "#/definitions/json_AtlasEntityHeader"
+}
}
},
"example" : {
- "enumDefs" : [ {
- "elementDefs" : [ {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- }, {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- } ],
- "defaultValue" : "...",
- "category" : "ENUM",
+ "queryType" : "FULL_TEXT",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
"guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
}
}, {
- "elementDefs" : [ {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- }, {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- } ],
- "defaultValue" : "...",
- "category" : "ARRAY",
"guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
}
} ],
- "structDefs" : [ {
- "attributeDefs" : [ {
- "name" : "...",
- "typeName" : "...",
- "isOptional" : true,
- "cardinality" : "LIST",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
- }, {
- "name" : "...",
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "isOptional" : true,
- "cardinality" : "LIST",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
- } ],
- "category" : "ARRAY",
- "guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
- }
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
}, {
- "attributeDefs" : [ {
- "name" : "...",
- "typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SINGLE",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
- }, {
- "name" : "...",
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SET",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
- } ],
- "category" : "ARRAY",
- "guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
- }
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
} ],
- "classificationDefs" : [ {
- "superTypes" : [ "...", "..." ],
- "attributeDefs" : [ {
- "name" : "...",
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SINGLE",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
- }, {
- "name" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SINGLE",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ { }, { } ]
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
+},
+ "description" : ""
+ }
+ ,
+ "json_AtlasStruct" : {
+ "type" : "object",
+ "title" : "AtlasStruct",
+ "properties" : {
+ "typeName" : {
+"description" : "",
+"type" : "string"
+ },
+ "attributes" : {
+"description" : "",
+"type" : "object",
+"additionalProperties" : {
+ "type" : "object"
+}
+ }
+ },
+ "example" : {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
+ }
+ ,
+ "json_AtlasStructDef" : {
+ "type" : "object",
+ "title" : "AtlasStructDef",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasBaseTypeDef"
+ },
+ {
+ "properties" : {
+ "attributeDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasAttributeDef"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "ENTITY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+},
+ "description" : "class that captures details of a struct-type."
+ }
+ ,
+ "json_AtlasTypeDefHeader" : {
+ "type" : "object",
+ "title" : "AtlasTypeDefHeader",
+ "properties" : {
+ "guid" : {
+"description" : "",
+"type" : "string"
+ },
+ "name" : {
+"description" : "",
+"type" : "string"
+ },
+ "category" : {
+"description" : "",
+"$ref" : "#/definitions/json_TypeCategory"
+ }
+ },
+ "example" : {
+ "guid" : "...",
+ "name" : "...",
+ "category" : "ENTITY"
+},
+ "description" : ""
+ }
+ ,
+ "json_AtlasTypesDef" : {
+ "type" : "object",
+ "title" : "AtlasTypesDef",
+ "properties" : {
+ "enumDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasEnumDef"
+}
+ },
+ "structDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasStructDef"
+}
+ },
+ "classificationDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassificationDef"
+}
+ },
+ "entityDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasEntityDef"
+}
+ },
+ "relationshipDefs" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasRelationshipDef"
+}
+ },
+ "empty" : {
+"description" : "",
+"type" : "boolean"
+ }
+ },
+ "example" : {
+ "enumDefs" : [ {
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
} ],
+ "defaultValue" : "...",
"category" : "MAP",
"guid" : "...",
"createdBy" : "...",
@@ -1469,29 +1728,56 @@
"property2" : "..."
}
}, {
- "superTypes" : [ "...", "..." ],
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "structDefs" : [ {
"attributeDefs" : [ {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1505,9 +1791,7 @@
"property1" : "...",
"property2" : "..."
}
- } ],
- "entityDefs" : [ {
- "superTypes" : [ "...", "..." ],
+ }, {
"attributeDefs" : [ {
"name" : "...",
"typeName" : "...",
@@ -1517,19 +1801,21 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1543,17 +1829,19 @@
"property1" : "...",
"property2" : "..."
}
- }, {
+ } ],
+ "classificationDefs" : [ {
"superTypes" : [ "...", "..." ],
"attributeDefs" : [ {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1564,9 +1852,10 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1580,20 +1869,249 @@
"property1" : "...",
"property2" : "..."
}
- } ],
- "empty" : true
-},
- "description" : "A collection of atlas enum, struct, classification and entity definitions (models)."
- }
- ,
- "json_AttributeSearchResult" : {
- "type" : "object",
- "title" : "AttributeSearchResult",
- "properties" : {
- "name" : {
-"description" : "",
-"type" : "array",
-"items" : {
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "entityDefs" : [ {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "STRUCT",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "BOTH",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+},
+ "description" : ""
+ }
+ ,
+ "json_AttributeSearchResult" : {
+ "type" : "object",
+ "title" : "AttributeSearchResult",
+ "properties" : {
+ "name" : {
+"description" : "",
+"type" : "array",
+"items" : {
"type" : "string"
}
},
@@ -1609,7 +2127,7 @@
"name" : [ "...", "..." ],
"values" : [ ]
},
- "description" : "Search results for attribute(s)"
+ "description" : ""
}
,
"json_Cardinality" : {
@@ -1620,7 +2138,7 @@
"LIST",
"SET"
],
- "description" : "Cardinality of an attribute i.e. single-valued or multi-valued."
+ "description" : "single-valued attribute or multi-valued attribute."
}
,
"json_ClassificationAssociateRequest" : {
@@ -1649,7 +2167,17 @@
},
"entityGuids" : [ "...", "..." ]
},
- "description" : "Tag association request for a list of entities"
+ "description" : ""
+ }
+ ,
+ "json_Condition" : {
+ "type" : "string",
+ "title" : "Condition",
+ "enum" : [
+ "AND",
+ "OR"
+ ],
+ "description" : ""
}
,
"json_EntityMutationResponse" : {
@@ -1718,7 +2246,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1728,7 +2256,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1749,7 +2277,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1775,7 +2303,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1796,7 +2324,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1807,7 +2335,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1849,7 +2377,7 @@
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1860,7 +2388,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1881,7 +2409,7 @@
}
}
},
- "description" : "Entity modification response. Contains entity headers for each successful modification (create/update/delete)"
+ "description" : ""
}
,
"json_EntityOperation" : {
@@ -1893,38 +2421,107 @@
"PARTIAL_UPDATE",
"DELETE"
],
- "description" : "Entity operations supported by Atlas via REST"
- }
- ,
- "json_LineageDirection" : {
- "type" : "string",
- "title" : "LineageDirection",
- "enum" : [
- "INPUT",
- "OUTPUT",
- "BOTH"
- ],
- "description" : "Lineage direction"
+ "description" : ""
}
,
- "json_LineageRelation" : {
+ "json_FilterCriteria" : {
"type" : "object",
- "title" : "LineageRelation",
+ "title" : "FilterCriteria",
"properties" : {
- "fromEntityId" : {
+ "attributeName" : {
"description" : "",
"type" : "string"
},
- "toEntityId" : {
+ "operator" : {
+"description" : "",
+"$ref" : "#/definitions/json_Operator"
+ },
+ "attributeValue" : {
"description" : "",
"type" : "string"
- }
- },
- "example" : {
- "fromEntityId" : "...",
- "toEntityId" : "..."
-},
- "description" : "Lineage relation between two entities"
+ },
+ "condition" : {
+"description" : "",
+"$ref" : "#/definitions/json_Condition"
+ },
+ "criterion" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_FilterCriteria"
+}
+ }
+ },
+ "example" : {
+ "attributeName" : "...",
+ "operator" : "LTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ {
+ "attributeName" : "...",
+ "operator" : "LT",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ }, {
+ "attributeName" : "...",
+ "operator" : "ENDS_WITH",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ } ]
+},
+ "description" : ""
+ }
+ ,
+ "json_LineageDirection" : {
+ "type" : "string",
+ "title" : "LineageDirection",
+ "enum" : [
+ "INPUT",
+ "OUTPUT",
+ "BOTH"
+ ],
+ "description" : ""
+ }
+ ,
+ "json_LineageRelation" : {
+ "type" : "object",
+ "title" : "LineageRelation",
+ "properties" : {
+ "fromEntityId" : {
+"description" : "",
+"type" : "string"
+ },
+ "toEntityId" : {
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "fromEntityId" : "...",
+ "toEntityId" : "..."
+},
+ "description" : ""
+ }
+ ,
+ "json_Operator" : {
+ "type" : "string",
+ "title" : "Operator",
+ "enum" : [
+ "LT",
+ "GT",
+ "LTE",
+ "GTE",
+ "EQ",
+ "NEQ",
+ "IN",
+ "LIKE",
+ "STARTS_WITH",
+ "ENDS_WITH",
+ "CONTAINS"
+ ],
+ "description" : "Supported search operations\nLogical comparision operators can only be used with numbers or dates\nIN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text"
}
,
"json_PList" : {
@@ -1964,12 +2561,105 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "DESC",
+ "sortType" : "NONE",
"sortBy" : "..."
},
"description" : "Paginated-list, for returning search results."
}
,
+ "json_PropagateTags" : {
+ "type" : "string",
+ "title" : "PropagateTags",
+ "enum" : [
+ "NONE",
+ "ONE_TO_TWO",
+ "TWO_TO_ONE",
+ "BOTH"
+ ],
+ "description" : "PropagateTags indicates whether tags should propagate across the relationship instance.\nTags can propagate:\nNONE - not at all\nONE_TO_TWO - from end 1 to 2\nTWO_TO_ONE - from end 2 to 1\nBOTH - both ways\n\nCare needs to be taken when specifying. The use cases we are aware of where this flag is useful:\n\n- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here\n- propagating classifications around Glossary synonyms - BOTH could be used here.\n\nThere is an expectation that further enhancements will allow more granular control of tag propagation and will\naddress how to resolve conflicts."
+ }
+ ,
+ "json_RelationshipCategory" : {
+ "type" : "string",
+ "title" : "RelationshipCategory",
+ "enum" : [
+ "ASSOCIATION",
+ "AGGREGATION",
+ "COMPOSITION"
+ ],
+ "description" : "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment.\nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independant."
+ }
+ ,
+ "json_SearchParameters" : {
+ "type" : "object",
+ "title" : "SearchParameters",
+ "properties" : {
+ "query" : {
+"description" : "",
+"type" : "string"
+ },
+ "typeName" : {
+"description" : "",
+"type" : "string"
+ },
+ "classification" : {
+"description" : "",
+"type" : "string"
+ },
+ "excludeDeletedEntities" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "limit" : {
+"description" : "",
+"type" : "number"
+ },
+ "offset" : {
+"description" : "",
+"type" : "number"
+ },
+ "entityFilters" : {
+"description" : "Entity attribute filters for the type (if type name is specified)",
+"$ref" : "#/definitions/json_FilterCriteria"
+ },
+ "tagFilters" : {
+"description" : "Tag attribute filters for the classification/tag (if tag name is specified)",
+"$ref" : "#/definitions/json_FilterCriteria"
+ },
+ "attributes" : {
+"description" : "Attribute values included in the results",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ }
+ },
+ "example" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+},
+ "description" : ""
+ }
+ ,
"json_SortType" : {
"type" : "string",
"title" : "SortType",
@@ -1978,7 +2668,7 @@
"ASC",
"DESC"
],
- "description" : "Type of sorting to be applied on the result set, defaults to NONE"
+ "description" : "to specify whether the result should be sorted? If yes, whether asc or desc."
}
,
"json_Status" : {
@@ -1988,7 +2678,17 @@
"ACTIVE",
"DELETED"
],
- "description" : "Status of the entity - can be active or deleted."
+ "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store."
+ }
+ ,
+ "json_Status_AtlasRelationship" : {
+ "type" : "string",
+ "title" : "Status",
+ "enum" : [
+ "ACTIVE",
+ "DELETED"
+ ],
+ "description" : ""
}
,
"json_TypeCategory" : {
@@ -2002,25 +2702,190 @@
"CLASSIFICATION",
"ENTITY",
"ARRAY",
- "MAP"
+ "MAP",
+ "RELATIONSHIP"
+ ],
+ "description" : ""
+ }
+ ,
+ "xml_ns0_PList" : {
+ "type" : "object",
+ "title" : "PList",
+ "allOf" : [
+ {
+ "properties" : {
+ "list" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "object"
+ },
+ "pageSize" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "number"
+ },
+ "sortBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "string"
+ },
+ "sortType" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"$ref" : "#/definitions/xml_ns0_sortType"
+ },
+ "startIndex" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "number"
+ },
+ "totalCount" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "number"
+ }
+ }
+ }
+ ],
+ "description" : "Paginated-list, for returning search results."
+ }
+ ,
+ "xml_ns0_searchFilter" : {
+ "type" : "object",
+ "title" : "searchFilter",
+ "allOf" : [
+ {
+ "properties" : {
+ "getCount" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "boolean"
+ },
+ "maxRows" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "number"
+ },
+ "params" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "object"
+ },
+ "sortBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "string"
+ },
+ "sortType" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"$ref" : "#/definitions/xml_ns0_sortType"
+ },
+ "startIndex" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "number"
+ }
+ }
+ }
+ ],
+ "description" : "Generic filter, to specify search criteria using name/value pairs."
+ }
+ ,
+ "xml_ns0_sortType" : {
+ "type" : "string",
+ "title" : "sortType",
+ "enum" : [
+ "NONE",
+ "ASC",
+ "DESC"
],
- "description" : "Category of a defined type"
+ "description" : "to specify whether the result should be sorted? If yes, whether asc or desc."
+ }
+ ,
+ "xml_ns0_atlasClassification" : {
+ "type" : "object",
+ "title" : "atlasClassification",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ {
+ }
+ ],
+ "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity."
+ }
+ ,
+ "xml_ns0_atlasStruct" : {
+ "type" : "object",
+ "title" : "atlasStruct",
+ "allOf" : [
+ {
+ "properties" : {
+ "attributes" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "object"
+ },
+ "typeName" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
}
},
"paths": {
- "\/v2/search/basic" : {
+ "\/v2/search/attribute" : {
"get" : {
"tags" : [ "DiscoveryREST" ],
- "summary" : "Retrieve data for the specified fulltext query.",
- "description" : "Retrieve data for the specified fulltext query",
- "operationId" : "resource_DiscoveryREST_searchUsingBasic_GET",
+ "summary" : "Retrieve data for the specified attribute search query.",
+ "description" : "Retrieve data for the specified attribute search query",
+ "operationId" : "resource_DiscoveryREST_searchUsingAttribute_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
- "name" : "classification",
+ "name" : "attrName",
"in" : "query",
"type" : "string",
- "description" : "limit the result to only entities tagged with the given classification or or its sub-types"
+ "description" : "Attribute name"
+ },
+ {
+ "name" : "attrValuePrefix",
+ "in" : "query",
+ "type" : "string",
+ "description" : "Attibute value to search on"
},
{
"name" : "limit",
@@ -2035,12 +2900,6 @@
"description" : "start offset of the result set (useful for pagination)"
},
{
- "name" : "query",
- "in" : "query",
- "type" : "string",
- "description" : "Fulltext query"
- },
- {
"name" : "typeName",
"in" : "query",
"type" : "string",
@@ -2057,7 +2916,30 @@
},
"examples" : {
"application/json" : {
- "queryType" : "GREMLIN",
+ "queryType" : "FULL_TEXT",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "LIKE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
@@ -2073,7 +2955,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2102,7 +2984,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2112,7 +2994,31 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
},
"description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results"
@@ -2122,7 +3028,30 @@
},
"examples" : {
"application/json" : {
- "queryType" : "BASIC",
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
@@ -2138,7 +3067,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2154,7 +3083,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2167,7 +3096,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2177,21 +3106,45 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
},
- "description" : "Invalid fulltext or query parameters"
+ "description" : "Invalid wildcard or query parameters"
}
}
}
}
,
- "\/v2/search/dsl" : {
+ "\/v2/search/basic" : {
"get" : {
"tags" : [ "DiscoveryREST" ],
- "summary" : "Retrieve data for the specified DSL.",
- "description" : "Retrieve data for the specified DSL",
- "operationId" : "resource_DiscoveryREST_searchUsingDSL_GET",
+ "summary" : "Retrieve data for the specified fulltext query.",
+ "description" : "Retrieve data for the specified fulltext query",
+ "operationId" : "resource_DiscoveryREST_searchUsingBasic_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
@@ -2201,6 +3154,12 @@
"description" : "limit the result to only entities tagged with the given classification or or its sub-types"
},
{
+ "name" : "excludeDeletedEntities",
+ "in" : "query",
+ "type" : "boolean",
+ "description" : ""
+ },
+ {
"name" : "limit",
"in" : "query",
"type" : "integer",
@@ -2216,7 +3175,7 @@
"name" : "query",
"in" : "query",
"type" : "string",
- "description" : "DSL query"
+ "description" : "Fulltext query"
},
{
"name" : "typeName",
@@ -2235,13 +3194,36 @@
},
"examples" : {
"application/json" : {
- "queryType" : "DSL",
+ "queryType" : "FULL_TEXT",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GT",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "LTE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2267,7 +3249,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2290,23 +3272,70 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
},
- "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results"
+ "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results"
},
"400" : {
"headers" : {
},
"examples" : {
"application/json" : {
- "queryType" : "DSL",
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "LTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2316,7 +3345,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2332,7 +3361,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2345,7 +3374,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2355,40 +3384,54 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
},
- "description" : "Invalid DSL or query parameters"
+ "description" : "Invalid fulltext or query parameters"
}
}
}
- }
- ,
- "\/v2/search/fulltext" : {
- "get" : {
+ ,
+ "post" : {
"tags" : [ "DiscoveryREST" ],
- "summary" : "Retrieve data for the specified fulltext query.",
- "description" : "Retrieve data for the specified fulltext query",
- "operationId" : "resource_DiscoveryREST_searchUsingFullText_GET",
+ "summary" : "Attribute based search for entities satisfying the search parameters.",
+ "description" : "Attribute based search for entities satisfying the search parameters",
+ "operationId" : "resource_DiscoveryREST_searchWithParameters_POST",
+ "consumes" : [ "application/json;charset=UTF-8" ],
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
- "name" : "limit",
- "in" : "query",
- "type" : "integer",
- "description" : "limit the result set to only include the specified number of entries"
- },
- {
- "name" : "offset",
- "in" : "query",
- "type" : "integer",
- "description" : "start offset of the result set (useful for pagination)"
- },
- {
- "name" : "query",
- "in" : "query",
- "type" : "string",
- "description" : "Fulltext query"
+ "name" : "body",
+ "in" : "body",
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_SearchParameters"
+ },
+ "description" : "Search parameters"
}
],
"responses" : {
@@ -2401,13 +3444,36 @@
},
"examples" : {
"application/json" : {
- "queryType" : "FULL_TEXT",
+ "queryType" : "ATTRIBUTE",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "LIKE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2417,7 +3483,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2456,23 +3522,70 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}
},
- "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results"
+ "description" : "On successful search"
},
"400" : {
"headers" : {
},
"examples" : {
"application/json" : {
- "queryType" : "BASIC",
+ "queryType" : "ATTRIBUTE",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2482,7 +3595,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2511,7 +3624,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2521,46 +3634,9 @@
}
},
"score" : 12345.0
- } ]
-}
- },
- "description" : "Invalid fulltext or query parameters"
- }
- }
- }
- }
- ,
- "\/v2/entity" : {
- "post" : {
- "tags" : [ "EntityREST" ],
- "summary" : "Create new entity or update existing entity in Atlas.",
- "description" : "Create new entity or update existing entity in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName",
- "operationId" : "resource_EntityREST_createOrUpdate_POST",
- "consumes" : [ "application/json;charset=UTF-8" ],
- "produces" : [ "application/json;charset=UTF-8" ],
- "parameters" : [
- {
- "name" : "body",
- "in" : "body",
- "schema" : {
-"description" : "",
-"$ref" : "#/definitions/json_AtlasEntityWithExtInfo"
- },
- "description" : ""
- }
- ],
- "responses" : {
- "201" : {
- "schema" : {
-"description" : "",
-"$ref" : "#/definitions/json_EntityMutationResponse"
- },
- "headers" : {
- },
- "examples" : {
- "application/json" : {
- "mutatedEntities" : {
- "property1" : [ {
+ } ],
+ "referredEntities" : {
+ "property1" : {
"guid" : "...",
"status" : "ACTIVE",
"displayText" : "...",
@@ -2570,7 +3646,8 @@
"property1" : { },
"property2" : { }
}
- }, {
+ },
+ "property2" : {
"guid" : "...",
"status" : "DELETED",
"displayText" : "...",
@@ -2580,189 +3657,119 @@
"property1" : { },
"property2" : { }
}
- } ],
- "property2" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
- },
- "guidAssignments" : {
- "property1" : "...",
- "property2" : "..."
- },
- "createdEntities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "updatedEntities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "partialUpdatedEntities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "deletedEntities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "firstEntityCreated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "firstEntityUpdated" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "firstEntityPartialUpdated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
}
}
}
},
- "description" : "Success"
+ "description" : "Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name"
}
}
}
}
,
- "\/v2/entity/bulk" : {
- "delete" : {
- "tags" : [ "EntityREST" ],
- "summary" : "Bulk API to delete list of entities identified by its GUIDs.",
- "description" : "Bulk API to delete list of entities identified by its GUIDs",
- "operationId" : "resource_EntityREST_deleteByGuids_DELETE",
+ "\/v2/search/dsl" : {
+ "get" : {
+ "tags" : [ "DiscoveryREST" ],
+ "summary" : "Retrieve data for the specified DSL.",
+ "description" : "Retrieve data for the specified DSL",
+ "operationId" : "resource_DiscoveryREST_searchUsingDSL_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
- "name" : "guid",
+ "name" : "classification",
"in" : "query",
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "collectionFormat" : "multi",
- "description" : ""
+ "type" : "string",
+ "description" : "limit the result to only entities tagged with the given classification or or its sub-types"
+ },
+ {
+ "name" : "limit",
+ "in" : "query",
+ "type" : "integer",
+ "description" : "limit the result set to only include the specified number of entries"
+ },
+ {
+ "name" : "offset",
+ "in" : "query",
+ "type" : "integer",
+ "description" : "start offset of the result set (useful for pagination)"
+ },
+ {
+ "name" : "query",
+ "in" : "query",
+ "type" : "string",
+ "description" : "DSL query"
+ },
+ {
+ "name" : "typeName",
+ "in" : "query",
+ "type" : "string",
+ "description" : "limit the result to only entities of specified type or its sub-types"
}
],
"responses" : {
- "204" : {
+ "200" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_EntityMutationResponse"
+"$ref" : "#/definitions/json_AtlasSearchResult"
},
"headers" : {
},
"examples" : {
"application/json" : {
- "mutatedEntities" : {
- "property1" : [ {
+ "queryType" : "BASIC",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "LIKE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
"guid" : "...",
"status" : "DELETED",
"displayText" : "...",
@@ -2772,7 +3779,10 @@
"property1" : { },
"property2" : { }
}
- }, {
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
"guid" : "...",
"status" : "ACTIVE",
"displayText" : "...",
@@ -2782,10 +3792,13 @@
"property1" : { },
"property2" : { }
}
- } ],
- "property2" : [ {
+ },
+ "score" : 12345.0
+ } ],
+ "referredEntities" : {
+ "property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2793,7 +3806,8 @@
"property1" : { },
"property2" : { }
}
- }, {
+ },
+ "property2" : {
"guid" : "...",
"status" : "ACTIVE",
"displayText" : "...",
@@ -2803,76 +3817,45 @@
"property1" : { },
"property2" : { }
}
- } ]
- },
- "guidAssignments" : {
- "property1" : "...",
- "property2" : "..."
- },
- "createdEntities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
}
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "updatedEntities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "partialUpdatedEntities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "deletedEntities" : [ {
+ }
+}
+ },
+ "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results"
+ },
+ "400" : {
+ "headers" : {
+ },
+ "examples" : {
+ "application/json" : {
+ "queryType" : "DSL",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
"guid" : "...",
"status" : "ACTIVE",
"displayText" : "...",
@@ -2893,95 +3876,144 @@
"property2" : { }
}
} ],
- "firstEntityCreated" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "firstEntityUpdated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
+ "attributes" : {
+ "name" :
<TRUNCATED>
[3/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resources.html
----------------------------------------------------------------------
diff --git a/api/v2/resources.html b/api/v2/resources.html
index fcfffb4..04acdb2 100644
--- a/api/v2/resources.html
+++ b/api/v2/resources.html
@@ -84,11 +84,13 @@
<tr class="clickable-row" data-href="resource_DiscoveryREST.html">
<td> <span class="resource-name">DiscoveryREST</span>
</td>
- <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/basic</span>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/basic</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -110,7 +112,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
-</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -127,6 +129,18 @@
<td> <span class="resource-description">REST interface for an entity's lineage information</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="resource_RelationshipREST.html">
+ <td> <span class="resource-name">RelationshipREST</span>
+</td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span>
+</samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span>
+</samp></li></ul></td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
+</samp></li></ul></td>
+ <td> <span class="resource-description">REST interface for entity relationships.</span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="resource_TypesREST.html">
<td> <span class="resource-name">TypesREST</span>
</td>
@@ -138,6 +152,8 @@
</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span>
@@ -155,6 +171,8 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">REST interface for CRUD operations on type definitions</span>
</td>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/syntax_json.html
----------------------------------------------------------------------
diff --git a/api/v2/syntax_json.html b/api/v2/syntax_json.html
index 1f2d1f3..599bc6b 100644
--- a/api/v2/syntax_json.html
+++ b/api/v2/syntax_json.html
@@ -73,13 +73,13 @@
<tr class="clickable-row" data-href="json_AtlasAttributeDef.html">
<td> <span class="datatype-name">AtlasAttributeDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-attribute.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html">
<td> <span class="datatype-name">AtlasBaseTypeDef</span>
</td>
- <td> <span class="datatype-description">Common-attributes for all Atlas types.</span>
+ <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassification.html">
@@ -91,7 +91,7 @@
<tr class="clickable-row" data-href="json_AtlasClassificationDef.html">
<td> <span class="datatype-name">AtlasClassificationDef</span>
</td>
- <td> <span class="datatype-description">Details of a classification-type.</span>
+ <td> <span class="datatype-description">class that captures details of a classification-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassifications.html">
@@ -103,31 +103,31 @@
<tr class="clickable-row" data-href="json_AtlasConstraintDef.html">
<td> <span class="datatype-name">AtlasConstraintDef</span>
</td>
- <td> <span class="datatype-description">Details of a constraint.</span>
+ <td> <span class="datatype-description">class that captures details of a constraint.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span>
</td>
- <td> <span class="datatype-description">List of Atlas entity along with the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntity.html">
<td> <span class="datatype-name">AtlasEntity</span>
</td>
- <td> <span class="datatype-description">Atlas entity representation</span>
+ <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityDef.html">
<td> <span class="datatype-name">AtlasEntityDef</span>
</td>
- <td> <span class="datatype-description">Details of an entity-type.</span>
+ <td> <span class="datatype-description">class that captures details of a entity-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html">
<td> <span class="datatype-name">AtlasEntityExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity representation along with extended info which included the entities being referred to</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityHeader.html">
@@ -139,109 +139,179 @@
<tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntityWithExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity with information about the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumDef.html">
<td> <span class="datatype-name">AtlasEnumDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-type.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumElementDef.html">
<td> <span class="datatype-name">AtlasEnumElementDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-element.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-element.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasFullTextResult.html">
<td> <span class="datatype-name">AtlasFullTextResult</span>
</td>
- <td> <span class="datatype-description">Search results for FullText APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasLineageInfo.html">
<td> <span class="datatype-name">AtlasLineageInfo</span>
</td>
- <td> <span class="datatype-description">Lineage information for a single entity</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasObjectId.html">
+ <td> <span class="datatype-name">AtlasObjectId</span>
+</td>
+ <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasQueryType.html">
<td> <span class="datatype-name">AtlasQueryType</span>
</td>
- <td> <span class="datatype-description">Various querying mechanisms supported by Atlas</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationship.html">
+ <td> <span class="datatype-name">AtlasRelationship</span>
+</td>
+ <td> <span class="datatype-description">Atlas relationship instance.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipDef</span>
+</td>
+ <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipEndDef</span>
+</td>
+ <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasSearchResult.html">
<td> <span class="datatype-name">AtlasSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results of the Discovery APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStruct.html">
<td> <span class="datatype-name">AtlasStruct</span>
</td>
- <td> <span class="datatype-description">Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStructDef.html">
<td> <span class="datatype-name">AtlasStructDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-type.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html">
<td> <span class="datatype-name">AtlasTypeDefHeader</span>
</td>
- <td> <span class="datatype-description">Minimal set of information about a type definition</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypesDef.html">
<td> <span class="datatype-name">AtlasTypesDef</span>
</td>
- <td> <span class="datatype-description">A collection of atlas enum, struct, classification and entity definitions (models).</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AttributeSearchResult.html">
<td> <span class="datatype-name">AttributeSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results for attribute(s)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Cardinality.html">
<td> <span class="datatype-name">Cardinality</span>
</td>
- <td> <span class="datatype-description">Cardinality of an attribute i.e. single-valued or multi-valued.</span>
+ <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html">
<td> <span class="datatype-name">ClassificationAssociateRequest</span>
</td>
- <td> <span class="datatype-description">Tag association request for a list of entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Condition.html">
+ <td> <span class="datatype-name">Condition</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityMutationResponse.html">
<td> <span class="datatype-name">EntityMutationResponse</span>
</td>
- <td> <span class="datatype-description">Entity modification response. Contains entity headers for each successful modification (create/update/delete)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityOperation.html">
<td> <span class="datatype-name">EntityOperation</span>
</td>
- <td> <span class="datatype-description">Entity operations supported by Atlas via REST</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_FilterCriteria.html">
+ <td> <span class="datatype-name">FilterCriteria</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageDirection.html">
<td> <span class="datatype-name">LineageDirection</span>
</td>
- <td> <span class="datatype-description">Lineage direction</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageRelation.html">
<td> <span class="datatype-name">LineageRelation</span>
</td>
- <td> <span class="datatype-description">Lineage relation between two entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Operator.html">
+ <td> <span class="datatype-name">Operator</span>
+</td>
+ <td> <span class="datatype-description">Supported search operations
+Logical comparision operators can only be used with numbers or dates
+IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PList.html">
@@ -250,22 +320,65 @@
<td> <span class="datatype-description">Paginated-list, for returning search results.</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="json_PropagateTags.html">
+ <td> <span class="datatype-name">PropagateTags</span>
+</td>
+ <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance.
+Tags can propagate:
+NONE - not at all
+ONE_TO_TWO - from end 1 to 2
+TWO_TO_ONE - from end 2 to 1
+BOTH - both ways
+
+Care needs to be taken when specifying. The use cases we are aware of where this flag is useful:
+
+- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here
+- propagating classifications around Glossary synonyms - BOTH could be used here.
+
+There is an expectation that further enhancements will allow more granular control of tag propagation and will
+address how to resolve conflicts.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_RelationshipCategory.html">
+ <td> <span class="datatype-name">RelationshipCategory</span>
+</td>
+ <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle.
+UML terminology is used for the values.
+ASSOCIATION is a relationship with no containment.
+COMPOSITION and AGGREGATION are containment relationships.
+The difference being in the lifecycles of the container and its children. In the COMPOSITION case,
+the children cannot exist without the container. For AGGREGATION, the life cycles
+of the container and children are totally independant.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_SearchParameters.html">
+ <td> <span class="datatype-name">SearchParameters</span>
+</td>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="json_SortType.html">
<td> <span class="datatype-name">SortType</span>
</td>
- <td> <span class="datatype-description">Type of sorting to be applied on the result set, defaults to NONE</span>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Status.html">
<td> <span class="datatype-name">Status</span>
</td>
- <td> <span class="datatype-description">Status of the entity - can be active or deleted.</span>
+ <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html">
+ <td> <span class="datatype-name">Status</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_TypeCategory.html">
<td> <span class="datatype-name">TypeCategory</span>
</td>
- <td> <span class="datatype-description">Category of a defined type</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/syntax_xml.html
----------------------------------------------------------------------
diff --git a/api/v2/syntax_xml.html b/api/v2/syntax_xml.html
index 674aa04..f18e7c8 100644
--- a/api/v2/syntax_xml.html
+++ b/api/v2/syntax_xml.html
@@ -89,188 +89,18 @@
<td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
</td>
</tr>
- <tr class="clickable-row" data-href="xml_ns0_typeCategory.html">
- <td> <span class="datatype-name">typeCategory</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasSearchResult.html">
- <td> <span class="datatype-name">atlasSearchResult</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasFullTextResult.html">
- <td> <span class="datatype-name">atlasFullTextResult</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasQueryType.html">
- <td> <span class="datatype-name">atlasQueryType</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_attributeSearchResult.html">
- <td> <span class="datatype-name">attributeSearchResult</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
<tr class="clickable-row" data-href="xml_ns0_atlasClassification.html">
<td> <span class="datatype-name">atlasClassification</span>
</td>
<td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span>
</td>
</tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasEntity.html">
- <td> <span class="datatype-name">atlasEntity</span>
-</td>
- <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_status.html">
- <td> <span class="datatype-name">status</span>
-</td>
- <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasEntityHeader.html">
- <td> <span class="datatype-name">atlasEntityHeader</span>
-</td>
- <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasObjectId.html">
- <td> <span class="datatype-name">atlasObjectId</span>
-</td>
- <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span>
-</td>
- </tr>
<tr class="clickable-row" data-href="xml_ns0_atlasStruct.html">
<td> <span class="datatype-name">atlasStruct</span>
</td>
<td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
- <tr class="clickable-row" data-href="xml_ns0_classificationAssociateRequest.html">
- <td> <span class="datatype-name">classificationAssociateRequest</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_entityMutationResponse.html">
- <td> <span class="datatype-name">entityMutationResponse</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_entityMutations.html">
- <td> <span class="datatype-name">entityMutations</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_entityOperation.html">
- <td> <span class="datatype-name">entityOperation</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_guidMapping.html">
- <td> <span class="datatype-name">guidMapping</span>
-</td>
- <td> <span class="datatype-description">This stores a mapping of guid assignments that were made during the processing
-of a create or update entity request.
-.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasLineageInfo.html">
- <td> <span class="datatype-name">atlasLineageInfo</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_lineageDirection.html">
- <td> <span class="datatype-name">lineageDirection</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_lineageRelation.html">
- <td> <span class="datatype-name">lineageRelation</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasBaseTypeDef.html">
- <td> <span class="datatype-name">atlasBaseTypeDef</span>
-</td>
- <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasClassificationDef.html">
- <td> <span class="datatype-name">atlasClassificationDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of a classification-type.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasEntityDef.html">
- <td> <span class="datatype-name">atlasEntityDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of a entity-type.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasEnumDef.html">
- <td> <span class="datatype-name">atlasEnumDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of an enum-type.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasEnumElementDef.html">
- <td> <span class="datatype-name">atlasEnumElementDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of an enum-element.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasStructDef.html">
- <td> <span class="datatype-name">atlasStructDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of a struct-type.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasAttributeDef.html">
- <td> <span class="datatype-name">atlasAttributeDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of a struct-attribute.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_cardinality.html">
- <td> <span class="datatype-name">cardinality</span>
-</td>
- <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasConstraintDef.html">
- <td> <span class="datatype-name">atlasConstraintDef</span>
-</td>
- <td> <span class="datatype-description">class that captures details of a constraint.</span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasTypeDefHeader.html">
- <td> <span class="datatype-name">atlasTypeDefHeader</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
- <tr class="clickable-row" data-href="xml_ns0_atlasTypesDef.html">
- <td> <span class="datatype-name">atlasTypesDef</span>
-</td>
- <td> <span class="datatype-description"></span>
-</td>
- </tr>
</tbody>
</table>
[4/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/resource_TypesREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_TypesREST.html b/api/v2/resource_TypesREST.html
index de94d05..cc402f7 100644
--- a/api/v2/resource_TypesREST.html
+++ b/api/v2/resource_TypesREST.html
@@ -61,6 +61,8 @@
<li><a href="#resource_TypesREST_getEntityDefByName_GET"><abbr title="GET /v2/types/entitydef/name/{name}">GET /v2/types/entitydef/name/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getEnumDefByGuid_GET"><abbr title="GET /v2/types/enumdef/guid/{guid}">GET /v2/types/enumdef/guid/{gu...</abbr></a></li>
<li><a href="#resource_TypesREST_getEnumDefByName_GET"><abbr title="GET /v2/types/enumdef/name/{name}">GET /v2/types/enumdef/name/{na...</abbr></a></li>
+ <li><a href="#resource_TypesREST_getRelationshipDefByGuid_GET"><abbr title="GET /v2/types/relationshipdef/guid/{guid}">GET /v2/types/relationshipdef/...</abbr></a></li>
+ <li><a href="#resource_TypesREST_getRelationshipDefByName_GET"><abbr title="GET /v2/types/relationshipdef/name/{name}">GET /v2/types/relationshipdef/...</abbr></a></li>
<li><a href="#resource_TypesREST_getStructDefByGuid_GET"><abbr title="GET /v2/types/structdef/guid/{guid}">GET /v2/types/structdef/guid/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getStructDefByName_GET"><abbr title="GET /v2/types/structdef/name/{name}">GET /v2/types/structdef/name/{...</abbr></a></li>
<li><a href="#resource_TypesREST_getTypeDefByGuid_GET"><abbr title="GET /v2/types/typedef/guid/{guid}">GET /v2/types/typedef/guid/{gu...</abbr></a></li>
@@ -147,7 +149,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -172,7 +174,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -197,19 +199,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -228,11 +232,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -243,9 +248,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -271,6 +277,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -281,9 +288,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "MAP",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -303,24 +311,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -341,21 +351,23 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "CLASSIFICATION",
@@ -378,11 +390,68 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "BOTH",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
"cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -393,9 +462,65 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -496,7 +621,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -546,19 +671,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -582,16 +709,18 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "OBJECT_ID_TYPE",
@@ -615,11 +744,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -630,9 +760,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -652,24 +783,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -690,24 +823,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -732,19 +867,132 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
"cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -856,7 +1104,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -881,7 +1129,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -906,19 +1154,21 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -937,11 +1187,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -952,9 +1203,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -975,24 +1227,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1012,24 +1266,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1050,21 +1306,23 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "ENUM",
@@ -1087,11 +1345,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1102,9 +1361,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1119,13 +1379,124 @@ Accept: application/json
"property2" : "..."
}
} ],
- "empty" : true
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "BOTH",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+}
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
@@ -1143,7 +1514,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1168,7 +1539,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1193,6 +1564,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1203,6 +1575,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "PRIMITIVE",
@@ -1224,24 +1597,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1267,19 +1642,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1299,24 +1676,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1337,24 +1716,26 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1379,6 +1760,63 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1389,9 +1827,65 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1501,7 +1995,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "CLASSIFICATION",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1526,7 +2020,7 @@ Accept: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1546,24 +2040,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1582,24 +2078,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1620,24 +2118,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1657,11 +2157,12 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1672,9 +2173,10 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1700,6 +2202,7 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1710,6 +2213,7 @@ Accept: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "OBJECT_ID_TYPE",
@@ -1732,24 +2236,26 @@ Accept: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1764,32 +2270,143 @@ Accept: application/json
"property2" : "..."
}
} ],
- "empty" : true
-}
- </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">
-{
- "enumDefs" : [ {
- "elementDefs" : [ {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- }, {
- "value" : "...",
- "description" : "...",
- "ordinal" : 12345
- } ],
- "defaultValue" : "...",
- "category" : "CLASSIFICATION",
- "guid" : "...",
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+}
+ </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">
+{
+ "enumDefs" : [ {
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "ARRAY",
+ "guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -1813,7 +2430,7 @@ Content-Type: application/json
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENUM",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1838,19 +2455,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1874,19 +2493,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1912,19 +2533,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1949,19 +2572,21 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1982,11 +2607,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1997,9 +2623,10 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2024,6 +2651,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -2034,6 +2662,118 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "RELATIONSHIP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "TWO_TO_ONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "ARRAY",
@@ -2122,7 +2862,7 @@ Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
- "category" : "STRUCT"
+ "category" : "RELATIONSHIP"
} ]
</code>
</pre>
@@ -2222,6 +2962,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2244,6 +2985,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2366,11 +3108,12 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2393,6 +3136,7 @@ Content-Type: application/json
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2407,7 +3151,7 @@ Content-Type: application/json
}
} ]
} ],
- "category" : "ARRAY",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2515,11 +3259,186 @@ Content-Type: application/json
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_TypesREST_getEntityDefByName_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Get the entity definition by it's name (unique)</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">name</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">entity name</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">On successful lookup of the the entity definition by it's name</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">404</span></td>
+ <td><span class="response-condition">On Failed lookup for the given name</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_AtlasEntityDef.html">AtlasEntityDef</a>
+ (JSON)</span></td>
+ <td><span class="response-description">Entity definition</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/types/entitydef/name/{name}
+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">
+{
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
"cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -2533,30 +3452,121 @@ Content-Type: application/json
"property2" : { }
}
} ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_TypesREST_getEnumDefByGuid_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/guid/{guid} <a href="../v2/types/enumdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Get the enum definition for the given guid</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">enum guid</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">On successful lookup of the the enum definition by it's guid</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">404</span></td>
+ <td><span class="response-condition">On Failed lookup for the given guid</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_AtlasEnumDef.html">AtlasEnumDef</a>
+ (JSON)</span></td>
+ <td><span class="response-description">enum definition</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/types/enumdef/guid/{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">
+{
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
}, {
- "name" : "...",
- "typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SINGLE",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "constraints" : [ {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
} ],
- "category" : "OBJECT_ID_TYPE",
+ "defaultValue" : "...",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -2578,10 +3588,10 @@ Content-Type: application/json
</div>
</div>
- <div id="resource_TypesREST_getEntityDefByName_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+ <div id="resource_TypesREST_getEnumDefByName_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/name/{name} <a href="../v2/types/enumdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
- <p>Get the entity definition by it's name (unique)</p>
+ <p>Get the enum definition by it's name (unique)</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
@@ -2596,7 +3606,7 @@ Content-Type: application/json
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
- <td><span class="parameter-description">entity name</span></td>
+ <td><span class="parameter-description">enum name</span></td>
</tr>
</tbody>
</table>
@@ -2612,7 +3622,7 @@ Content-Type: application/json
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
- <td><span class="response-condition">On successful lookup of the the entity definition by it's name</span></td>
+ <td><span class="response-condition">On successful lookup of the the enum definition by it's name</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
@@ -2633,9 +3643,9 @@ Content-Type: application/json
<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_AtlasEntityDef.html">AtlasEntityDef</a>
+ <td><span class="datatype-reference"><a href="json_AtlasEnumDef.html">AtlasEnumDef</a>
(JSON)</span></td>
- <td><span class="response-description">Entity definition</span></td>
+ <td><span class="response-description">enum definition</span></td>
</tr>
</tbody>
</table>
@@ -2646,7 +3656,7 @@ Content-Type: application/json
<div class="col-md-6">
<h5>Request</h5>
<pre>
-GET /v2/types/entitydef/n
<TRUNCATED>
[6/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasTypesDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasTypesDef.html b/api/v2/json_AtlasTypesDef.html
index b0af19c..4a47bd4 100644
--- a/api/v2/json_AtlasTypesDef.html
+++ b/api/v2/json_AtlasTypesDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasTypesDef <small>Data Type</small></h1>
- <p>A collection of atlas enum, struct, classification and entity definitions (models).</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -115,6 +115,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">relationshipDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">empty</span>
</td>
<td> <span class="datatype-reference">boolean
@@ -140,7 +149,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -165,7 +174,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -185,11 +194,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -200,9 +210,10 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -221,24 +232,26 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -259,21 +272,23 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "STRUCT",
@@ -301,6 +316,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -311,9 +327,10 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -334,11 +351,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -349,9 +367,10 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -371,21 +390,79 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "relationshipDefs" : [ {
+ "relationshipCategory" : "ASSOCIATION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SINGLE",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
"cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "ENTITY",
@@ -402,6 +479,61 @@
"property1" : "...",
"property2" : "..."
}
+ }, {
+ "relationshipCategory" : "COMPOSITION",
+ "propagateTags" : "NONE",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "CLASSIFICATION",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
} ],
"empty" : true
}</pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AttributeSearchResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AttributeSearchResult.html b/api/v2/json_AttributeSearchResult.html
index 3b1029b..6cb1aee 100644
--- a/api/v2/json_AttributeSearchResult.html
+++ b/api/v2/json_AttributeSearchResult.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AttributeSearchResult <small>Data Type</small></h1>
- <p>Search results for attribute(s)</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_Cardinality.html
----------------------------------------------------------------------
diff --git a/api/v2/json_Cardinality.html b/api/v2/json_Cardinality.html
index 1e308b4..99a344c 100644
--- a/api/v2/json_Cardinality.html
+++ b/api/v2/json_Cardinality.html
@@ -63,7 +63,7 @@
<h1 class="page-header">Cardinality <small>Data Type</small></h1>
- <p>Cardinality of an attribute i.e. single-valued or multi-valued.</p>
+ <p>single-valued attribute or multi-valued attribute.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_ClassificationAssociateRequest.html
----------------------------------------------------------------------
diff --git a/api/v2/json_ClassificationAssociateRequest.html b/api/v2/json_ClassificationAssociateRequest.html
index cb57817..1cc02de 100644
--- a/api/v2/json_ClassificationAssociateRequest.html
+++ b/api/v2/json_ClassificationAssociateRequest.html
@@ -63,7 +63,7 @@
<h1 class="page-header">ClassificationAssociateRequest <small>Data Type</small></h1>
- <p>Tag association request for a list of entities</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_Condition.html
----------------------------------------------------------------------
diff --git a/api/v2/json_Condition.html b/api/v2/json_Condition.html
new file mode 100644
index 0000000..73d8e2b
--- /dev/null
+++ b/api/v2/json_Condition.html
@@ -0,0 +1,122 @@
+<!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: Condition</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: Condition</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_Condition.html">Condition</a></li>
+ </ol>
+
+ <h1 class="page-header">Condition <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">AND</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">OR</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_EntityMutationResponse.html
----------------------------------------------------------------------
diff --git a/api/v2/json_EntityMutationResponse.html b/api/v2/json_EntityMutationResponse.html
index c521625..5f4dd75 100644
--- a/api/v2/json_EntityMutationResponse.html
+++ b/api/v2/json_EntityMutationResponse.html
@@ -63,7 +63,7 @@
<h1 class="page-header">EntityMutationResponse <small>Data Type</small></h1>
- <p>Entity modification response. Contains entity headers for each successful modification (create/update/delete)</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -168,7 +168,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -189,7 +189,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -199,7 +199,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -215,7 +215,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -246,7 +246,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -299,7 +299,7 @@
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -321,7 +321,7 @@
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_EntityOperation.html
----------------------------------------------------------------------
diff --git a/api/v2/json_EntityOperation.html b/api/v2/json_EntityOperation.html
index d4dea52..8ce779a 100644
--- a/api/v2/json_EntityOperation.html
+++ b/api/v2/json_EntityOperation.html
@@ -63,7 +63,7 @@
<h1 class="page-header">EntityOperation <small>Data Type</small></h1>
- <p>Entity operations supported by Atlas via REST</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_FilterCriteria.html
----------------------------------------------------------------------
diff --git a/api/v2/json_FilterCriteria.html b/api/v2/json_FilterCriteria.html
new file mode 100644
index 0000000..243fdc6
--- /dev/null
+++ b/api/v2/json_FilterCriteria.html
@@ -0,0 +1,182 @@
+<!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: FilterCriteria</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: FilterCriteria</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_FilterCriteria.html">FilterCriteria</a></li>
+ </ol>
+
+ <h1 class="page-header">FilterCriteria <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">attributeName</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">operator</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Operator.html">Operator</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">attributeValue</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">condition</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Condition.html">Condition</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">criterion</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_FilterCriteria.html">FilterCriteria</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ {
+ "attributeName" : "...",
+ "operator" : "ENDS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ }, {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ } ]
+}</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_LineageDirection.html
----------------------------------------------------------------------
diff --git a/api/v2/json_LineageDirection.html b/api/v2/json_LineageDirection.html
index 772073d..1ba367f 100644
--- a/api/v2/json_LineageDirection.html
+++ b/api/v2/json_LineageDirection.html
@@ -63,7 +63,7 @@
<h1 class="page-header">LineageDirection <small>Data Type</small></h1>
- <p>Lineage direction</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_LineageRelation.html
----------------------------------------------------------------------
diff --git a/api/v2/json_LineageRelation.html b/api/v2/json_LineageRelation.html
index 33d49b0..66bc468 100644
--- a/api/v2/json_LineageRelation.html
+++ b/api/v2/json_LineageRelation.html
@@ -63,7 +63,7 @@
<h1 class="page-header">LineageRelation <small>Data Type</small></h1>
- <p>Lineage relation between two entities</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_Operator.html
----------------------------------------------------------------------
diff --git a/api/v2/json_Operator.html b/api/v2/json_Operator.html
new file mode 100644
index 0000000..333b019
--- /dev/null
+++ b/api/v2/json_Operator.html
@@ -0,0 +1,160 @@
+<!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: Operator</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: Operator</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_Operator.html">Operator</a></li>
+ </ol>
+
+ <h1 class="page-header">Operator <small>Data Type</small></h1>
+
+ <p>Supported search operations
+Logical comparision operators can only be used with numbers or dates
+IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">LT</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">GT</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">LTE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">GTE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">EQ</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">NEQ</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">IN</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">LIKE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">STARTS_WITH</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">ENDS_WITH</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">CONTAINS</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_PList.html
----------------------------------------------------------------------
diff --git a/api/v2/json_PList.html b/api/v2/json_PList.html
index fca561b..73e19a7 100644
--- a/api/v2/json_PList.html
+++ b/api/v2/json_PList.html
@@ -142,7 +142,7 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "DESC",
+ "sortType" : "NONE",
"sortBy" : "..."
}</pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_PropagateTags.html
----------------------------------------------------------------------
diff --git a/api/v2/json_PropagateTags.html b/api/v2/json_PropagateTags.html
new file mode 100644
index 0000000..13bbc6c
--- /dev/null
+++ b/api/v2/json_PropagateTags.html
@@ -0,0 +1,143 @@
+<!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: PropagateTags</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: PropagateTags</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_PropagateTags.html">PropagateTags</a></li>
+ </ol>
+
+ <h1 class="page-header">PropagateTags <small>Data Type</small></h1>
+
+ <p>PropagateTags indicates whether tags should propagate across the relationship instance.
+Tags can propagate:
+NONE - not at all
+ONE_TO_TWO - from end 1 to 2
+TWO_TO_ONE - from end 2 to 1
+BOTH - both ways
+
+Care needs to be taken when specifying. The use cases we are aware of where this flag is useful:
+
+- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here
+- propagating classifications around Glossary synonyms - BOTH could be used here.
+
+There is an expectation that further enhancements will allow more granular control of tag propagation and will
+address how to resolve conflicts.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">NONE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">ONE_TO_TWO</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">TWO_TO_ONE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">BOTH</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_RelationshipCategory.html
----------------------------------------------------------------------
diff --git a/api/v2/json_RelationshipCategory.html b/api/v2/json_RelationshipCategory.html
new file mode 100644
index 0000000..e4329b6
--- /dev/null
+++ b/api/v2/json_RelationshipCategory.html
@@ -0,0 +1,132 @@
+<!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: RelationshipCategory</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: RelationshipCategory</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_RelationshipCategory.html">RelationshipCategory</a></li>
+ </ol>
+
+ <h1 class="page-header">RelationshipCategory <small>Data Type</small></h1>
+
+ <p>The Relationship category determines the style of relationship around containment and lifecycle.
+UML terminology is used for the values.
+ASSOCIATION is a relationship with no containment.
+COMPOSITION and AGGREGATION are containment relationships.
+The difference being in the lifecycles of the container and its children. In the COMPOSITION case,
+the children cannot exist without the container. For AGGREGATION, the life cycles
+of the container and children are totally independant.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">ASSOCIATION</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">AGGREGATION</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">COMPOSITION</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_SearchParameters.html
----------------------------------------------------------------------
diff --git a/api/v2/json_SearchParameters.html b/api/v2/json_SearchParameters.html
new file mode 100644
index 0000000..ccf9d46
--- /dev/null
+++ b/api/v2/json_SearchParameters.html
@@ -0,0 +1,222 @@
+<!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: SearchParameters</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: SearchParameters</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_SearchParameters.html">SearchParameters</a></li>
+ </ol>
+
+ <h1 class="page-header">SearchParameters <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">query</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">typeName</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">classification</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">excludeDeletedEntities</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">limit</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">offset</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">entityFilters</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a>
+</span>
+</td>
+ <td> <span class="property-description">Entity attribute filters for the type (if type name is specified)</span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">tagFilters</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a>
+</span>
+</td>
+ <td> <span class="property-description">Tag attribute filters for the classification/tag (if tag name is specified)</span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">attributes</span>
+</td>
+ <td> <span class="datatype-reference">array of string
+</span>
+</td>
+ <td> <span class="property-description">Attribute values included in the results</span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+}</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_SortType.html
----------------------------------------------------------------------
diff --git a/api/v2/json_SortType.html b/api/v2/json_SortType.html
index 3c4831a..aefc77b 100644
--- a/api/v2/json_SortType.html
+++ b/api/v2/json_SortType.html
@@ -63,7 +63,7 @@
<h1 class="page-header">SortType <small>Data Type</small></h1>
- <p>Type of sorting to be applied on the result set, defaults to NONE</p>
+ <p>to specify whether the result should be sorted? If yes, whether asc or desc.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_Status.html
----------------------------------------------------------------------
diff --git a/api/v2/json_Status.html b/api/v2/json_Status.html
index 73aab28..7eb0987 100644
--- a/api/v2/json_Status.html
+++ b/api/v2/json_Status.html
@@ -63,7 +63,7 @@
<h1 class="page-header">Status <small>Data Type</small></h1>
- <p>Status of the entity - can be active or deleted.</p>
+ <p>Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_Status_AtlasRelationship.html
----------------------------------------------------------------------
diff --git a/api/v2/json_Status_AtlasRelationship.html b/api/v2/json_Status_AtlasRelationship.html
new file mode 100644
index 0000000..f455e2b
--- /dev/null
+++ b/api/v2/json_Status_AtlasRelationship.html
@@ -0,0 +1,122 @@
+<!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: Status</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: Status</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_Status_AtlasRelationship.html">Status</a></li>
+ </ol>
+
+ <h1 class="page-header">Status <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-values">
+ <caption>Values</caption>
+ <thead>
+ <tr>
+ <th>value</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="value-value">ACTIVE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">DELETED</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_TypeCategory.html
----------------------------------------------------------------------
diff --git a/api/v2/json_TypeCategory.html b/api/v2/json_TypeCategory.html
index e7ff9b8..29ff07f 100644
--- a/api/v2/json_TypeCategory.html
+++ b/api/v2/json_TypeCategory.html
@@ -63,7 +63,7 @@
<h1 class="page-header">TypeCategory <small>Data Type</small></h1>
- <p>Category of a defined type</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -109,6 +109,10 @@
<td><span class="value-value">MAP</span></td>
<td><span class="value-description"></span></td>
</tr>
+ <tr>
+ <td><span class="value-value">RELATIONSHIP</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/ns0.xsd
----------------------------------------------------------------------
diff --git a/api/v2/ns0.xsd b/api/v2/ns0.xsd
index f0a2142..cdb7997 100644
--- a/api/v2/ns0.xsd
+++ b/api/v2/ns0.xsd
@@ -5,30 +5,8 @@
<xs:element name="PList" type="PList"/>
<xs:element name="searchFilter" type="searchFilter"/>
- <xs:element name="atlasSearchResult" type="atlasSearchResult"/>
- <xs:element name="atlasFullTextResult" type="atlasFullTextResult"/>
- <xs:element name="attributeSearchResult" type="attributeSearchResult"/>
<xs:element name="atlasClassification" type="atlasClassification"/>
- <xs:element name="atlasEntity" type="atlasEntity"/>
- <xs:element name="atlasEntityHeader" type="atlasEntityHeader"/>
- <xs:element name="atlasObjectId" type="atlasObjectId"/>
<xs:element name="atlasStruct" type="atlasStruct"/>
- <xs:element name="classificationAssociateRequest" type="classificationAssociateRequest"/>
- <xs:element name="entityMutationResponse" type="entityMutationResponse"/>
- <xs:element name="entityMutations" type="entityMutations"/>
- <xs:element name="guidMapping" type="guidMapping"/>
- <xs:element name="atlasLineageInfo" type="atlasLineageInfo"/>
- <xs:element name="lineageRelation" type="lineageRelation"/>
- <xs:element name="atlasBaseTypeDef" type="atlasBaseTypeDef"/>
- <xs:element name="atlasClassificationDef" type="atlasClassificationDef"/>
- <xs:element name="atlasEntityDef" type="atlasEntityDef"/>
- <xs:element name="atlasEnumDef" type="atlasEnumDef"/>
- <xs:element name="atlasEnumElementDef" type="atlasEnumElementDef"/>
- <xs:element name="atlasStructDef" type="atlasStructDef"/>
- <xs:element name="atlasAttributeDef" type="atlasAttributeDef"/>
- <xs:element name="atlasConstraintDef" type="atlasConstraintDef"/>
- <xs:element name="atlasTypeDefHeader" type="atlasTypeDefHeader"/>
- <xs:element name="atlasTypesDef" type="atlasTypesDef"/>
<xs:complexType name="PList">
<xs:annotation>
<xs:documentation>
@@ -101,71 +79,6 @@
</xs:restriction>
</xs:simpleType>
-<xs:simpleType name="typeCategory">
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="PRIMITIVE"/>
-
- <xs:enumeration value="OBJECT_ID_TYPE"/>
-
- <xs:enumeration value="ENUM"/>
-
- <xs:enumeration value="STRUCT"/>
-
- <xs:enumeration value="CLASSIFICATION"/>
-
- <xs:enumeration value="ENTITY"/>
-
- <xs:enumeration value="ARRAY"/>
-
- <xs:enumeration value="MAP"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="atlasSearchResult">
- <xs:sequence>
- <xs:element name="queryText" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="queryType" type="atlasQueryType" minOccurs="0">
- </xs:element>
- <xs:element name="entities" type="atlasEntityHeader" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="attributes" type="attributeSearchResult" minOccurs="0">
- </xs:element>
- <xs:element name="fullTextResult" type="atlasFullTextResult" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasFullTextResult">
- <xs:sequence>
- <xs:element name="entity" type="atlasEntityHeader" minOccurs="0">
- </xs:element>
- <xs:element name="score" type="xs:double" minOccurs="0">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:simpleType name="atlasQueryType">
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="DSL"/>
-
- <xs:enumeration value="FULL_TEXT"/>
-
- <xs:enumeration value="GREMLIN"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="attributeSearchResult">
- <xs:sequence>
- <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="values" type="xs:anyType" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
<xs:complexType name="atlasClassification">
<xs:annotation>
<xs:documentation>
@@ -178,100 +91,6 @@
</xs:complexContent>
</xs:complexType>
-<xs:complexType name="atlasEntity">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[An instance of an entity - like hive_table, hive_database.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasStruct">
- <xs:sequence>
- <xs:element name="guid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="status" type="status" minOccurs="0">
- </xs:element>
- <xs:element name="createdBy" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="updatedBy" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="createTime" type="xs:dateTime" minOccurs="0">
- </xs:element>
- <xs:element name="updateTime" type="xs:dateTime" minOccurs="0">
- </xs:element>
- <xs:element name="version" type="xs:long" minOccurs="0">
- </xs:element>
- <xs:element name="classifications" type="atlasClassification" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:simpleType name="status">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="ACTIVE"/>
-
- <xs:enumeration value="DELETED"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="atlasEntityHeader">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[An instance of an entity - like hive_table, hive_database.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasStruct">
- <xs:sequence>
- <xs:element name="guid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="status" type="status" minOccurs="0">
- </xs:element>
- <xs:element name="displayText" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="classificationNames" type="xs:string" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:complexType name="atlasObjectId">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[Reference to an object-instance of an Atlas type - like entity.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="guid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="typeName" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="uniqueAttributes" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="xs:anyType"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
<xs:complexType name="atlasStruct">
<xs:annotation>
<xs:documentation>
@@ -298,353 +117,4 @@
</xs:sequence>
</xs:complexType>
-<xs:complexType name="classificationAssociateRequest">
- <xs:sequence>
- <xs:element name="classification" type="atlasClassification" minOccurs="0">
- </xs:element>
- <xs:element name="entityGuids" type="xs:string" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="entityMutationResponse">
- <xs:sequence>
- <xs:element name="mutatedEntities" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="entityOperation"/>
- <xs:element name="value" minOccurs="1" type="xs:anyType"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name="guidAssignments" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="entityMutations">
- </xs:complexType>
-
-<xs:simpleType name="entityOperation">
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="CREATE"/>
-
- <xs:enumeration value="UPDATE"/>
-
- <xs:enumeration value="PARTIAL_UPDATE"/>
-
- <xs:enumeration value="DELETE"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="guidMapping">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[This stores a mapping of guid assignments that were made during the processing
-of a create or update entity request.
-.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="guidAssignments" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasLineageInfo">
- <xs:sequence>
- <xs:element name="baseEntityGuid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="guidEntityMap" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="atlasEntityHeader"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name="relations" type="lineageRelation" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="lineageDirection" type="lineageDirection" minOccurs="0">
- </xs:element>
- <xs:element name="lineageDepth" type="xs:int" minOccurs="1">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:simpleType name="lineageDirection">
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="INPUT"/>
-
- <xs:enumeration value="OUTPUT"/>
-
- <xs:enumeration value="BOTH"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="lineageRelation">
- <xs:sequence>
- <xs:element name="fromEntityId" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="toEntityId" type="xs:string" minOccurs="0">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasBaseTypeDef" abstract="true">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[Base class that captures common-attributes for all Atlas types.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="guid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="createdBy" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="updatedBy" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="createTime" type="xs:dateTime" minOccurs="0">
- </xs:element>
- <xs:element name="updateTime" type="xs:dateTime" minOccurs="0">
- </xs:element>
- <xs:element name="version" type="xs:long" minOccurs="0">
- </xs:element>
- <xs:element name="name" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="description" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="typeVersion" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="options" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasClassificationDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of a classification-type.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasStructDef">
- <xs:sequence>
- <xs:element name="superTypes" type="xs:string" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:complexType name="atlasEntityDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of a entity-type.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasStructDef">
- <xs:sequence>
- <xs:element name="superTypes" type="xs:string" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:complexType name="atlasEnumDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of an enum-type.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasBaseTypeDef">
- <xs:sequence>
- <xs:element name="elementDefs" type="atlasEnumElementDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="defaultValue" type="xs:string" minOccurs="0">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:complexType name="atlasEnumElementDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of an enum-element.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="value" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="description" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="ordinal" type="xs:int" minOccurs="0">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasStructDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of a struct-type.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:complexContent>
- <xs:extension base="atlasBaseTypeDef">
- <xs:sequence>
- <xs:element name="attributeDefs" type="atlasAttributeDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
- </xs:extension>
- </xs:complexContent>
-</xs:complexType>
-
-<xs:complexType name="atlasAttributeDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of a struct-attribute.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="name" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="typeName" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="isOptional" type="xs:boolean" minOccurs="1">
- </xs:element>
- <xs:element name="cardinality" type="cardinality" minOccurs="0">
- </xs:element>
- <xs:element name="valuesMinCount" type="xs:int" minOccurs="1">
- </xs:element>
- <xs:element name="valuesMaxCount" type="xs:int" minOccurs="1">
- </xs:element>
- <xs:element name="isUnique" type="xs:boolean" minOccurs="1">
- </xs:element>
- <xs:element name="isIndexable" type="xs:boolean" minOccurs="1">
- </xs:element>
- <xs:element name="constraints" type="atlasConstraintDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:simpleType name="cardinality">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[single-valued attribute or multi-valued attribute.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:restriction base="xs:string">
-
- <xs:enumeration value="SINGLE"/>
-
- <xs:enumeration value="LIST"/>
-
- <xs:enumeration value="SET"/>
- </xs:restriction>
-</xs:simpleType>
-
-<xs:complexType name="atlasConstraintDef">
- <xs:annotation>
- <xs:documentation>
- <![CDATA[class that captures details of a constraint.]]>
- </xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="type" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="params" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="key" minOccurs="1" type="xs:string"/>
- <xs:element name="value" minOccurs="1" type="xs:anyType"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasTypeDefHeader">
- <xs:sequence>
- <xs:element name="guid" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="name" type="xs:string" minOccurs="0">
- </xs:element>
- <xs:element name="category" type="typeCategory" minOccurs="0">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
-<xs:complexType name="atlasTypesDef">
- <xs:sequence>
- <xs:element name="enumDefs" type="atlasEnumDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="structDefs" type="atlasStructDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="classificationDefs" type="atlasClassificationDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- <xs:element name="entityDefs" type="atlasEntityDef" minOccurs="0" maxOccurs="unbounded">
- </xs:element>
- </xs:sequence>
-</xs:complexType>
-
</xs:schema>
\ No newline at end of file
[7/8] atlas-website git commit: Updated with latest V2 API docs
Posted by ap...@apache.org.
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/index.html
----------------------------------------------------------------------
diff --git a/api/v2/index.html b/api/v2/index.html
index 6f95e61..e784603 100644
--- a/api/v2/index.html
+++ b/api/v2/index.html
@@ -52,6 +52,7 @@
<ul class="nav nav-sidebar">
<li><a href="#resources">Resources</a></li>
<li><a href="#syntax_json">JSON</a></li>
+ <li><a href="#syntax_xml">XML</a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -92,11 +93,13 @@
<tr class="clickable-row" data-href="resource_DiscoveryREST.html">
<td> <span class="resource-name">DiscoveryREST</span>
</td>
- <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/basic</span>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span>
+</samp></li><li><samp> <span class="resource-path">/v2/search/basic</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span>
</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -118,7 +121,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
-</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
@@ -135,6 +138,18 @@
<td> <span class="resource-description">REST interface for an entity's lineage information</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="resource_RelationshipREST.html">
+ <td> <span class="resource-name">RelationshipREST</span>
+</td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span>
+</samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span>
+</samp></li></ul></td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
+</samp></li></ul></td>
+ <td> <span class="resource-description">REST interface for entity relationships.</span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="resource_TypesREST.html">
<td> <span class="resource-name">TypesREST</span>
</td>
@@ -146,6 +161,8 @@
</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span>
+</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span>
@@ -163,6 +180,8 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">REST interface for CRUD operations on type definitions</span>
</td>
@@ -185,13 +204,13 @@
<tr class="clickable-row" data-href="json_AtlasAttributeDef.html">
<td> <span class="datatype-name">AtlasAttributeDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-attribute.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html">
<td> <span class="datatype-name">AtlasBaseTypeDef</span>
</td>
- <td> <span class="datatype-description">Common-attributes for all Atlas types.</span>
+ <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassification.html">
@@ -203,7 +222,7 @@
<tr class="clickable-row" data-href="json_AtlasClassificationDef.html">
<td> <span class="datatype-name">AtlasClassificationDef</span>
</td>
- <td> <span class="datatype-description">Details of a classification-type.</span>
+ <td> <span class="datatype-description">class that captures details of a classification-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasClassifications.html">
@@ -215,31 +234,31 @@
<tr class="clickable-row" data-href="json_AtlasConstraintDef.html">
<td> <span class="datatype-name">AtlasConstraintDef</span>
</td>
- <td> <span class="datatype-description">Details of a constraint.</span>
+ <td> <span class="datatype-description">class that captures details of a constraint.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span>
</td>
- <td> <span class="datatype-description">List of Atlas entity along with the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntity.html">
<td> <span class="datatype-name">AtlasEntity</span>
</td>
- <td> <span class="datatype-description">Atlas entity representation</span>
+ <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityDef.html">
<td> <span class="datatype-name">AtlasEntityDef</span>
</td>
- <td> <span class="datatype-description">Details of an entity-type.</span>
+ <td> <span class="datatype-description">class that captures details of a entity-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html">
<td> <span class="datatype-name">AtlasEntityExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity representation along with extended info which included the entities being referred to</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEntityHeader.html">
@@ -251,109 +270,179 @@
<tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html">
<td> <span class="datatype-name">AtlasEntityWithExtInfo</span>
</td>
- <td> <span class="datatype-description">Entity with information about the referred entities</span>
+ <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumDef.html">
<td> <span class="datatype-name">AtlasEnumDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-type.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasEnumElementDef.html">
<td> <span class="datatype-name">AtlasEnumElementDef</span>
</td>
- <td> <span class="datatype-description">Details of an enum-element.</span>
+ <td> <span class="datatype-description">class that captures details of an enum-element.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasFullTextResult.html">
<td> <span class="datatype-name">AtlasFullTextResult</span>
</td>
- <td> <span class="datatype-description">Search results for FullText APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasLineageInfo.html">
<td> <span class="datatype-name">AtlasLineageInfo</span>
</td>
- <td> <span class="datatype-description">Lineage information for a single entity</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasObjectId.html">
+ <td> <span class="datatype-name">AtlasObjectId</span>
+</td>
+ <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasQueryType.html">
<td> <span class="datatype-name">AtlasQueryType</span>
</td>
- <td> <span class="datatype-description">Various querying mechanisms supported by Atlas</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationship.html">
+ <td> <span class="datatype-name">AtlasRelationship</span>
+</td>
+ <td> <span class="datatype-description">Atlas relationship instance.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipDef</span>
+</td>
+ <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html">
+ <td> <span class="datatype-name">AtlasRelationshipEndDef</span>
+</td>
+ <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasSearchResult.html">
<td> <span class="datatype-name">AtlasSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results of the Discovery APIs</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStruct.html">
<td> <span class="datatype-name">AtlasStruct</span>
</td>
- <td> <span class="datatype-description">Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasStructDef.html">
<td> <span class="datatype-name">AtlasStructDef</span>
</td>
- <td> <span class="datatype-description">Details of a struct-type.</span>
+ <td> <span class="datatype-description">class that captures details of a struct-type.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html">
<td> <span class="datatype-name">AtlasTypeDefHeader</span>
</td>
- <td> <span class="datatype-description">Minimal set of information about a type definition</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AtlasTypesDef.html">
<td> <span class="datatype-name">AtlasTypesDef</span>
</td>
- <td> <span class="datatype-description">A collection of atlas enum, struct, classification and entity definitions (models).</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_AttributeSearchResult.html">
<td> <span class="datatype-name">AttributeSearchResult</span>
</td>
- <td> <span class="datatype-description">Search results for attribute(s)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Cardinality.html">
<td> <span class="datatype-name">Cardinality</span>
</td>
- <td> <span class="datatype-description">Cardinality of an attribute i.e. single-valued or multi-valued.</span>
+ <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html">
<td> <span class="datatype-name">ClassificationAssociateRequest</span>
</td>
- <td> <span class="datatype-description">Tag association request for a list of entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Condition.html">
+ <td> <span class="datatype-name">Condition</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityMutationResponse.html">
<td> <span class="datatype-name">EntityMutationResponse</span>
</td>
- <td> <span class="datatype-description">Entity modification response. Contains entity headers for each successful modification (create/update/delete)</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_EntityOperation.html">
<td> <span class="datatype-name">EntityOperation</span>
</td>
- <td> <span class="datatype-description">Entity operations supported by Atlas via REST</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_FilterCriteria.html">
+ <td> <span class="datatype-name">FilterCriteria</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageDirection.html">
<td> <span class="datatype-name">LineageDirection</span>
</td>
- <td> <span class="datatype-description">Lineage direction</span>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LineageRelation.html">
<td> <span class="datatype-name">LineageRelation</span>
</td>
- <td> <span class="datatype-description">Lineage relation between two entities</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Operator.html">
+ <td> <span class="datatype-name">Operator</span>
+</td>
+ <td> <span class="datatype-description">Supported search operations
+Logical comparision operators can only be used with numbers or dates
+IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PList.html">
@@ -362,22 +451,109 @@
<td> <span class="datatype-description">Paginated-list, for returning search results.</span>
</td>
</tr>
+ <tr class="clickable-row" data-href="json_PropagateTags.html">
+ <td> <span class="datatype-name">PropagateTags</span>
+</td>
+ <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance.
+Tags can propagate:
+NONE - not at all
+ONE_TO_TWO - from end 1 to 2
+TWO_TO_ONE - from end 2 to 1
+BOTH - both ways
+
+Care needs to be taken when specifying. The use cases we are aware of where this flag is useful:
+
+- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here
+- propagating classifications around Glossary synonyms - BOTH could be used here.
+
+There is an expectation that further enhancements will allow more granular control of tag propagation and will
+address how to resolve conflicts.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_RelationshipCategory.html">
+ <td> <span class="datatype-name">RelationshipCategory</span>
+</td>
+ <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle.
+UML terminology is used for the values.
+ASSOCIATION is a relationship with no containment.
+COMPOSITION and AGGREGATION are containment relationships.
+The difference being in the lifecycles of the container and its children. In the COMPOSITION case,
+the children cannot exist without the container. For AGGREGATION, the life cycles
+of the container and children are totally independant.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_SearchParameters.html">
+ <td> <span class="datatype-name">SearchParameters</span>
+</td>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="json_SortType.html">
<td> <span class="datatype-name">SortType</span>
</td>
- <td> <span class="datatype-description">Type of sorting to be applied on the result set, defaults to NONE</span>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Status.html">
<td> <span class="datatype-name">Status</span>
</td>
- <td> <span class="datatype-description">Status of the entity - can be active or deleted.</span>
+ <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html">
+ <td> <span class="datatype-name">Status</span>
+</td>
+ <td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_TypeCategory.html">
<td> <span class="datatype-name">TypeCategory</span>
</td>
- <td> <span class="datatype-description">Category of a defined type</span>
+ <td> <span class="datatype-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3>
+
+ <table class="table table-hover datatypes">
+ <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption>
+ <thead>
+ <tr>
+ <th align="center">type</th>
+ <th align="center">description</th>
+ </tr>
+ </thead>
+ <tbody data-link="row" class="rowlink">
+ <tr class="clickable-row" data-href="xml_ns0_PList.html">
+ <td> <span class="datatype-name">PList</span>
+</td>
+ <td> <span class="datatype-description">Paginated-list, for returning search results.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_searchFilter.html">
+ <td> <span class="datatype-name">searchFilter</span>
+</td>
+ <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_sortType.html">
+ <td> <span class="datatype-name">sortType</span>
+</td>
+ <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html">
+ <td> <span class="datatype-name">atlasClassification</span>
+</td>
+ <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span>
+</td>
+ </tr>
+ <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html">
+ <td> <span class="datatype-name">atlasStruct</span>
+</td>
+ <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span>
</td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasAttributeDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasAttributeDef.html b/api/v2/json_AtlasAttributeDef.html
index ec24df2..974b43d 100644
--- a/api/v2/json_AtlasAttributeDef.html
+++ b/api/v2/json_AtlasAttributeDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasAttributeDef <small>Data Type</small></h1>
- <p>Details of a struct-attribute.</p>
+ <p>class that captures details of a struct-attribute.</p>
<dl class="dl-horizontal">
</dl>
@@ -151,6 +151,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">defaultValue</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">constraints</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a>
@@ -173,6 +182,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasBaseTypeDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasBaseTypeDef.html b/api/v2/json_AtlasBaseTypeDef.html
index eee5ce3..c7fe833 100644
--- a/api/v2/json_AtlasBaseTypeDef.html
+++ b/api/v2/json_AtlasBaseTypeDef.html
@@ -63,13 +63,13 @@
<h1 class="page-header">AtlasBaseTypeDef <small>Data Type</small></h1>
- <p>Common-attributes for all Atlas types.</p>
+ <p>Base class that captures common-attributes for all Atlas types.</p>
<dl class="dl-horizontal">
<dt>Abstract Type</dt>
<dd></dd>
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
+ <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
</dl>
<table class="table datatype-properties">
@@ -189,7 +189,7 @@
<div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div>
<pre class="prettyprint language-js example">{
- "category" : "PRIMITIVE",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasClassificationDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasClassificationDef.html b/api/v2/json_AtlasClassificationDef.html
index ceeb8d3..69a58b7 100644
--- a/api/v2/json_AtlasClassificationDef.html
+++ b/api/v2/json_AtlasClassificationDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasClassificationDef <small>Data Type</small></h1>
- <p>Details of a classification-type.</p>
+ <p>class that captures details of a classification-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -180,11 +180,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -207,6 +208,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -221,7 +223,7 @@
}
} ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasConstraintDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasConstraintDef.html b/api/v2/json_AtlasConstraintDef.html
index ebbdd5c..cdbfec0 100644
--- a/api/v2/json_AtlasConstraintDef.html
+++ b/api/v2/json_AtlasConstraintDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasConstraintDef <small>Data Type</small></h1>
- <p>Details of a constraint.</p>
+ <p>class that captures details of a constraint.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntitiesWithExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntitiesWithExtInfo.html b/api/v2/json_AtlasEntitiesWithExtInfo.html
index efb5642..5ce3fab 100644
--- a/api/v2/json_AtlasEntitiesWithExtInfo.html
+++ b/api/v2/json_AtlasEntitiesWithExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntitiesWithExtInfo <small>Data Type</small></h1>
- <p>List of Atlas entity along with the referred entities</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -106,12 +106,16 @@
<pre class="prettyprint language-js example">{
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -132,12 +136,16 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -166,6 +174,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -193,6 +205,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntity.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntity.html b/api/v2/json_AtlasEntity.html
index d277898..f0554e3 100644
--- a/api/v2/json_AtlasEntity.html
+++ b/api/v2/json_AtlasEntity.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntity <small>Data Type</small></h1>
- <p>Atlas entity representation</p>
+ <p>An instance of an entity - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -142,6 +142,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">relationshipAttributes</span>
+</td>
+ <td> <span class="datatype-reference">map of object
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">classifications</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a>
@@ -174,12 +183,16 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityDef.html b/api/v2/json_AtlasEntityDef.html
index e9757bf..98ddd09 100644
--- a/api/v2/json_AtlasEntityDef.html
+++ b/api/v2/json_AtlasEntityDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityDef <small>Data Type</small></h1>
- <p>Details of an entity-type.</p>
+ <p>class that captures details of a entity-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -180,11 +180,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -207,6 +208,7 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -221,7 +223,7 @@
}
} ]
} ],
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityExtInfo.html b/api/v2/json_AtlasEntityExtInfo.html
index 6fd0dd4..218f53a 100644
--- a/api/v2/json_AtlasEntityExtInfo.html
+++ b/api/v2/json_AtlasEntityExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityExtInfo <small>Data Type</small></h1>
- <p>Entity representation along with extended info which included the entities being referred to</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
@@ -98,12 +98,16 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -131,6 +135,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityHeader.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityHeader.html b/api/v2/json_AtlasEntityHeader.html
index 77999b9..b255a32 100644
--- a/api/v2/json_AtlasEntityHeader.html
+++ b/api/v2/json_AtlasEntityHeader.html
@@ -138,7 +138,7 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEntityWithExtInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEntityWithExtInfo.html b/api/v2/json_AtlasEntityWithExtInfo.html
index d3cd2a8..688b940 100644
--- a/api/v2/json_AtlasEntityWithExtInfo.html
+++ b/api/v2/json_AtlasEntityWithExtInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEntityWithExtInfo <small>Data Type</small></h1>
- <p>Entity with information about the referred entities</p>
+ <p>An instance of an entity along with extended info - like hive_table, hive_database.</p>
<dl class="dl-horizontal">
</dl>
@@ -106,12 +106,16 @@
<pre class="prettyprint language-js example">{
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -134,12 +138,16 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -167,6 +175,10 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEnumDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumDef.html b/api/v2/json_AtlasEnumDef.html
index 44cd237..af3de9f 100644
--- a/api/v2/json_AtlasEnumDef.html
+++ b/api/v2/json_AtlasEnumDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEnumDef <small>Data Type</small></h1>
- <p>Details of an enum-type.</p>
+ <p>class that captures details of an enum-type.</p>
<dl class="dl-horizontal">
</dl>
@@ -183,7 +183,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasEnumElementDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumElementDef.html b/api/v2/json_AtlasEnumElementDef.html
index e076a77..768d224 100644
--- a/api/v2/json_AtlasEnumElementDef.html
+++ b/api/v2/json_AtlasEnumElementDef.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasEnumElementDef <small>Data Type</small></h1>
- <p>Details of an enum-element.</p>
+ <p>class that captures details of an enum-element.</p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasFullTextResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasFullTextResult.html b/api/v2/json_AtlasFullTextResult.html
index eaa271a..e8f99f4 100644
--- a/api/v2/json_AtlasFullTextResult.html
+++ b/api/v2/json_AtlasFullTextResult.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasFullTextResult <small>Data Type</small></h1>
- <p>Search results for FullText APIs</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasLineageInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasLineageInfo.html b/api/v2/json_AtlasLineageInfo.html
index 65291d6..f73150a 100644
--- a/api/v2/json_AtlasLineageInfo.html
+++ b/api/v2/json_AtlasLineageInfo.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasLineageInfo <small>Data Type</small></h1>
- <p>Lineage information for a single entity</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -133,7 +133,7 @@
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -144,7 +144,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -161,7 +161,7 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "BOTH",
+ "lineageDirection" : "INPUT",
"lineageDepth" : 12345
}</pre>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasObjectId.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasObjectId.html b/api/v2/json_AtlasObjectId.html
index a39f7cf..e1bd8c3 100644
--- a/api/v2/json_AtlasObjectId.html
+++ b/api/v2/json_AtlasObjectId.html
@@ -105,42 +105,6 @@
<td> <span class="property-description"></span>
</td>
</tr>
- <tr>
- <td> <span class="property-name">validGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">assignedGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">unAssignedGuid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
- <tr>
- <td> <span class="property-name">valid</span>
-</td>
- <td> <span class="datatype-reference">boolean
-</span>
-</td>
- <td> <span class="property-description"></span>
-</td>
- </tr>
</tbody>
</table>
@@ -152,11 +116,7 @@
"uniqueAttributes" : {
"property1" : { },
"property2" : { }
- },
- "validGuid" : true,
- "assignedGuid" : true,
- "unAssignedGuid" : true,
- "valid" : true
+ }
}</pre>
<footer class="footer">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasQueryType.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasQueryType.html b/api/v2/json_AtlasQueryType.html
index 7161d50..71a2707 100644
--- a/api/v2/json_AtlasQueryType.html
+++ b/api/v2/json_AtlasQueryType.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasQueryType <small>Data Type</small></h1>
- <p>Various querying mechanisms supported by Atlas</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -93,6 +93,10 @@
<td><span class="value-value">BASIC</span></td>
<td><span class="value-description"></span></td>
</tr>
+ <tr>
+ <td><span class="value-value">ATTRIBUTE</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationship.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationship.html b/api/v2/json_AtlasRelationship.html
new file mode 100644
index 0000000..5d9086e
--- /dev/null
+++ b/api/v2/json_AtlasRelationship.html
@@ -0,0 +1,256 @@
+<!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: AtlasRelationship</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: AtlasRelationship</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationship.html">AtlasRelationship</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationship <small>Data Type</small></h1>
+
+ <p>Atlas relationship instance.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">guid</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">status</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Status_AtlasRelationship.html">Status</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">createdBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">updatedBy</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">createTime</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">updateTime</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">version</span>
+</td>
+ <td> <span class="datatype-reference">number
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">end1</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">end2</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">label</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStruct.html">AtlasStruct</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">typeName</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">attributes</span></td>
+ <td><span class="datatype-reference">map of object
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationshipDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationshipDef.html b/api/v2/json_AtlasRelationshipDef.html
new file mode 100644
index 0000000..e47b6a0
--- /dev/null
+++ b/api/v2/json_AtlasRelationshipDef.html
@@ -0,0 +1,350 @@
+<!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: AtlasRelationshipDef</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: AtlasRelationshipDef</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationshipDef <small>Data Type</small></h1>
+
+ <p>AtlasRelationshipDef is a TypeDef that defines a relationship.
+
+As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.
+The name and the guid are the 2 ways that the RelationshipDef is identified.
+
+RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally
+whether the end is a container.
+RelationshipDefs can have AttributeDefs - though only primitive types are allowed.
+RelationshipDefs have a relationshipCategory specifying the UML type of relationship required
+RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.
+
+The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs
+will not specify an EntityDef type name as their types.
+
+RelationshipDefs introduce new atributes to the entity instances. For example
+EntityDef A might have attributes attr1,attr2,attr3
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef AtoB might define 2 ends
+end1: type A, name attr7
+end1: type B, name attr8
+
+When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
+
+In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into
+the entity instances</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">relationshipCategory</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_RelationshipCategory.html">RelationshipCategory</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">propagateTags</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_PropagateTags.html">PropagateTags</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">endDef1</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">endDef2</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">relationshipLabel</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStructDef.html">AtlasStructDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">attributeDefs</span></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasAttributeDef.html">AtlasAttributeDef</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">category</span></td>
+ <td><span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">guid</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createdBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updatedBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updateTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">version</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">name</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">description</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">typeVersion</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">options</span></td>
+ <td><span class="datatype-reference">map of string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "relationshipCategory" : "AGGREGATION",
+ "propagateTags" : "ONE_TO_TWO",
+ "endDef1" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "LIST",
+ "isLegacyAttribute" : true
+ },
+ "endDef2" : {
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+ },
+ "relationshipLabel" : "...",
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "defaultValue" : "...",
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "STRUCT",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasRelationshipEndDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasRelationshipEndDef.html b/api/v2/json_AtlasRelationshipEndDef.html
new file mode 100644
index 0000000..998d349
--- /dev/null
+++ b/api/v2/json_AtlasRelationshipEndDef.html
@@ -0,0 +1,171 @@
+<!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: AtlasRelationshipEndDef</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: AtlasRelationshipEndDef</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 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="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasRelationshipEndDef <small>Data Type</small></h1>
+
+ <p>The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an
+attribute name, cardinality and whether it is the container end of the relationship.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">type</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">name</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">isContainer</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">cardinality</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">isLegacyAttribute</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "type" : "...",
+ "name" : "...",
+ "isContainer" : true,
+ "cardinality" : "SET",
+ "isLegacyAttribute" : true
+}</pre>
+
+ <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>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasSearchResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasSearchResult.html b/api/v2/json_AtlasSearchResult.html
index 6ec8144..0b95d99 100644
--- a/api/v2/json_AtlasSearchResult.html
+++ b/api/v2/json_AtlasSearchResult.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasSearchResult <small>Data Type</small></h1>
- <p>Search results of the Discovery APIs</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -88,6 +88,15 @@
</td>
</tr>
<tr>
+ <td> <span class="property-name">searchParameters</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
<td> <span class="property-name">queryText</span>
</td>
<td> <span class="datatype-reference">string
@@ -141,19 +150,51 @@
<td> <span class="property-description"></span>
</td>
</tr>
+ <tr>
+ <td> <span class="property-name">referredEntities</span>
+</td>
+ <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
- "queryType" : "BASIC",
+ "queryType" : "ATTRIBUTE",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "STARTS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
"queryText" : "...",
"type" : "...",
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -163,7 +204,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -202,7 +243,31 @@
}
},
"score" : 12345.0
- } ]
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
}</pre>
<footer class="footer">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasStruct.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStruct.html b/api/v2/json_AtlasStruct.html
index ac84929..5fe86c3 100644
--- a/api/v2/json_AtlasStruct.html
+++ b/api/v2/json_AtlasStruct.html
@@ -63,11 +63,11 @@
<h1 class="page-header">AtlasStruct <small>Data Type</small></h1>
- <p>Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
+ <p>Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasEntity.html">AtlasEntity</a>, <a href="json_AtlasClassification.html">AtlasClassification</a></dd>
+ <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasEntity.html">AtlasEntity</a>, <a href="json_AtlasClassification.html">AtlasClassification</a>, <a href="json_AtlasRelationship.html">AtlasRelationship</a></dd>
</dl>
<table class="table datatype-properties">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasStructDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStructDef.html b/api/v2/json_AtlasStructDef.html
index 2012978..04c153e 100644
--- a/api/v2/json_AtlasStructDef.html
+++ b/api/v2/json_AtlasStructDef.html
@@ -63,11 +63,11 @@
<h1 class="page-header">AtlasStructDef <small>Data Type</small></h1>
- <p>Details of a struct-type.</p>
+ <p>class that captures details of a struct-type.</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
- <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
+ <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd>
</dl>
<table class="table datatype-properties">
@@ -170,11 +170,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -192,11 +193,12 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
+ "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -211,7 +213,7 @@
}
} ]
} ],
- "category" : "ENUM",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/json_AtlasTypeDefHeader.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasTypeDefHeader.html b/api/v2/json_AtlasTypeDefHeader.html
index 3e12199..7a24dbb 100644
--- a/api/v2/json_AtlasTypeDefHeader.html
+++ b/api/v2/json_AtlasTypeDefHeader.html
@@ -63,7 +63,7 @@
<h1 class="page-header">AtlasTypeDefHeader <small>Data Type</small></h1>
- <p>Minimal set of information about a type definition</p>
+ <p></p>
<dl class="dl-horizontal">
</dl>
@@ -113,7 +113,7 @@
<pre class="prettyprint language-js example">{
"guid" : "...",
"name" : "...",
- "category" : "ENUM"
+ "category" : "STRUCT"
}</pre>
<footer class="footer">