http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasQueryType.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasQueryType.html b/1.1.0/api/v2/json_AtlasQueryType.html index 71a2707..c8f709f 100644 --- a/1.1.0/api/v2/json_AtlasQueryType.html +++ b/1.1.0/api/v2/json_AtlasQueryType.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,6 +50,13 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> + <li><a href="#DSL"><abbr title="DSL"><span class="sideoverflow">DSL</span></abbr></a></li> + <li><a href="#FULL_TEXT"><abbr title="FULL_TEXT"><span class="sideoverflow">FULL_TEXT</span></abbr></a></li> + <li><a href="#GREMLIN"><abbr title="GREMLIN"><span class="sideoverflow">GREMLIN</span></abbr></a></li> + <li><a href="#BASIC"><abbr title="BASIC"><span class="sideoverflow">BASIC</span></abbr></a></li> + <li><a href="#ATTRIBUTE"><abbr title="ATTRIBUTE"><span class="sideoverflow">ATTRIBUTE</span></abbr></a></li> + <li><a href="#RELATIONSHIP"><abbr title="RELATIONSHIP"><span class="sideoverflow">RELATIONSHIP</span></abbr></a></li> + <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> @@ -78,23 +85,27 @@ </thead> <tbody> <tr> - <td><span class="value-value">DSL</span></td> + <td><span class="value-value" id="DSL">DSL</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">FULL_TEXT</span></td> + <td><span class="value-value" id="FULL_TEXT">FULL_TEXT</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">GREMLIN</span></td> + <td><span class="value-value" id="GREMLIN">GREMLIN</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">BASIC</span></td> + <td><span class="value-value" id="BASIC">BASIC</span></td> <td><span class="value-description"></span></td> </tr> <tr> - <td><span class="value-value">ATTRIBUTE</span></td> + <td><span class="value-value" id="ATTRIBUTE">ATTRIBUTE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="RELATIONSHIP">RELATIONSHIP</span></td> <td><span class="value-description"></span></td> </tr> </tbody>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasRelatedCategoryHeader.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelatedCategoryHeader.html b/1.1.0/api/v2/json_AtlasRelatedCategoryHeader.html new file mode 100644 index 0000000..c90ead7 --- /dev/null +++ b/1.1.0/api/v2/json_AtlasRelatedCategoryHeader.html @@ -0,0 +1,170 @@ +<!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: AtlasRelatedCategoryHeader</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/enunciate.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelatedCategoryHeader</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_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a></li> + </ol> + + <h1 class="page-header">AtlasRelatedCategoryHeader <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 id="prop-categoryGuid" class="property-name">categoryGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-description" 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 id="prop-displayText" class="property-name">displayText</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-parentCategoryGuid" class="property-name">parentCategoryGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationGuid" class="property-name">relationGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." +}</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/3fad5df3/1.1.0/api/v2/json_AtlasRelatedObjectId.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelatedObjectId.html b/1.1.0/api/v2/json_AtlasRelatedObjectId.html new file mode 100644 index 0000000..22fe609 --- /dev/null +++ b/1.1.0/api/v2/json_AtlasRelatedObjectId.html @@ -0,0 +1,205 @@ +<!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: AtlasRelatedObjectId</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/enunciate.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelatedObjectId</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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a></li> + </ol> + + <h1 class="page-header">AtlasRelatedObjectId <small>Data Type</small></h1> + + <p>Reference to an object-instance of AtlasEntity type used in relationship attribute values</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 id="prop-displayText" class="property-name">displayText</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-entityStatus" class="property-name">entityStatus</span> +</td> + <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationshipAttributes" class="property-name">relationshipAttributes</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasStruct.html">AtlasStruct</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationshipGuid" class="property-name">relationshipGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationshipStatus" class="property-name">relationshipStatus</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> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasObjectId.html">AtlasObjectId</a></h5></td> + </tr> + <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">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">uniqueAttributes</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">{ + "displayText" : "...", + "entityStatus" : "DELETED", + "relationshipAttributes" : { + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "relationshipGuid" : "...", + "relationshipStatus" : "ACTIVE", + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "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/3fad5df3/1.1.0/api/v2/json_AtlasRelatedTermHeader.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelatedTermHeader.html b/1.1.0/api/v2/json_AtlasRelatedTermHeader.html new file mode 100644 index 0000000..9dd5e94 --- /dev/null +++ b/1.1.0/api/v2/json_AtlasRelatedTermHeader.html @@ -0,0 +1,200 @@ +<!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: AtlasRelatedTermHeader</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/enunciate.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelatedTermHeader</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_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a></li> + </ol> + + <h1 class="page-header">AtlasRelatedTermHeader <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 id="prop-description" 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 id="prop-displayText" class="property-name">displayText</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-expression" class="property-name">expression</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationGuid" class="property-name">relationGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-source" class="property-name">source</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-status" class="property-name">status</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasTermRelationshipStatus.html">AtlasTermRelationshipStatus</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-steward" class="property-name">steward</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-termGuid" class="property-name">termGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." +}</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/3fad5df3/1.1.0/api/v2/json_AtlasRelationship.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelationship.html b/1.1.0/api/v2/json_AtlasRelationship.html index 5d9086e..89e0f11 100644 --- a/1.1.0/api/v2/json_AtlasRelationship.html +++ b/1.1.0/api/v2/json_AtlasRelationship.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -79,7 +79,25 @@ </thead> <tbody> <tr> - <td> <span class="property-name">guid</span> + <td> <span id="prop-blockedPropagatedClassifications" class="property-name">blockedPropagatedClassifications</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-createTime" 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 id="prop-createdBy" class="property-name">createdBy</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,16 +106,25 @@ </td> </tr> <tr> - <td> <span class="property-name">status</span> + <td> <span id="prop-end1" class="property-name">end1</span> </td> - <td> <span class="datatype-reference"><a href="json_Status_AtlasRelationship.html">Status</a> + <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">createdBy</span> + <td> <span id="prop-end2" 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 id="prop-guid" class="property-name">guid</span> </td> <td> <span class="datatype-reference">string </span> @@ -106,7 +133,7 @@ </td> </tr> <tr> - <td> <span class="property-name">updatedBy</span> + <td> <span id="prop-homeId" class="property-name">homeId</span> </td> <td> <span class="datatype-reference">string </span> @@ -115,52 +142,52 @@ </td> </tr> <tr> - <td> <span class="property-name">createTime</span> + <td> <span id="prop-label" class="property-name">label</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">updateTime</span> + <td> <span id="prop-propagateTags" class="property-name">propagateTags</span> </td> - <td> <span class="datatype-reference">number + <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">version</span> + <td> <span id="prop-propagatedClassifications" class="property-name">propagatedClassifications</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">end1</span> + <td> <span id="prop-status" class="property-name">status</span> </td> - <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a> + <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">end2</span> + <td> <span id="prop-updateTime" class="property-name">updateTime</span> </td> - <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">label</span> + <td> <span id="prop-updatedBy" class="property-name">updatedBy</span> </td> <td> <span class="datatype-reference">string </span> @@ -168,20 +195,29 @@ <td> <span class="property-description"></span> </td> </tr> + <tr> + <td> <span id="prop-version" class="property-name">version</span> +</td> + <td> <span class="datatype-reference">number +</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 + <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> <tr> - <td><span class="property-name">attributes</span></td> - <td><span class="datatype-reference">map of object + <td><span class="property-name">typeName</span></td> + <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> @@ -191,13 +227,47 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", + "blockedPropagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, + "createdBy" : "...", "end1" : { "guid" : "...", "typeName" : "...", @@ -214,12 +284,58 @@ "property2" : { } } }, + "guid" : "...", + "homeId" : "...", "label" : "...", - "typeName" : "...", + "propagateTags" : "NONE", + "propagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasRelationshipDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelationshipDef.html b/1.1.0/api/v2/json_AtlasRelationshipDef.html index e47b6a0..16d58a4 100644 --- a/1.1.0/api/v2/json_AtlasRelationshipDef.html +++ b/1.1.0/api/v2/json_AtlasRelationshipDef.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -64,29 +64,34 @@ <h1 class="page-header">AtlasRelationshipDef <small>Data Type</small></h1> <p>AtlasRelationshipDef is a TypeDef that defines a relationship. - +<p> 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. - +<p> 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 +<p> +RelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br> +RelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br> RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships. - +<p> 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. - +<p> 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 +<p> +EntityDef A might have attributes attr1,attr2,attr3 <br> +EntityDef B might have attributes attr4,attr5,attr6 <br> +RelationshipDef AtoB might define 2 ends <br> -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 +<pre> + end1: type A, name attr7 + end2: type B, name attr8 </pre> +<p> +When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br> +When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 +<p> In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into the entity instances</p> @@ -104,43 +109,43 @@ the entity instances</p> </thead> <tbody> <tr> - <td> <span class="property-name">relationshipCategory</span> + <td> <span id="prop-endDef1" class="property-name">endDef1</span> </td> - <td> <span class="datatype-reference"><a href="json_RelationshipCategory.html">RelationshipCategory</a> + <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">propagateTags</span> + <td> <span id="prop-endDef2" class="property-name">endDef2</span> </td> - <td> <span class="datatype-reference"><a href="json_PropagateTags.html">PropagateTags</a> + <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">endDef1</span> + <td> <span id="prop-propagateTags" class="property-name">propagateTags</span> </td> - <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a> + <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">endDef2</span> + <td> <span id="prop-relationshipCategory" class="property-name">relationshipCategory</span> </td> - <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a> + <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">relationshipLabel</span> + <td> <span id="prop-relationshipLabel" class="property-name">relationshipLabel</span> </td> <td> <span class="datatype-reference">string </span> @@ -171,8 +176,8 @@ the entity instances</p> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">guid</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">createTime</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -183,50 +188,56 @@ the entity instances</p> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">updatedBy</span></td> + <td><span class="property-name">dateFormatter</span></td> + <td><span class="datatype-reference"><a href="json_DateFormat.html">DateFormat</a> +</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">createTime</span></td> - <td><span class="datatype-reference">number + <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">updateTime</span></td> - <td><span class="datatype-reference">number + <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">version</span></td> - <td><span class="datatype-reference">number + <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> <tr> - <td><span class="property-name">name</span></td> + <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">description</span></td> - <td><span class="datatype-reference">string + <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">typeVersion</span></td> + <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">options</span></td> - <td><span class="datatype-reference">map of string + <td><span class="property-name">version</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -236,84 +247,131 @@ the entity instances</p> <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "relationshipCategory" : "AGGREGATION", - "propagateTags" : "ONE_TO_TWO", "endDef1" : { - "type" : "...", - "name" : "...", + "cardinality" : "SET", + "description" : "...", "isContainer" : true, - "cardinality" : "LIST", - "isLegacyAttribute" : true + "isLegacyAttribute" : true, + "name" : "...", + "type" : "..." }, "endDef2" : { - "type" : "...", - "name" : "...", + "cardinality" : "LIST", + "description" : "...", "isContainer" : true, - "cardinality" : "SET", - "isLegacyAttribute" : true + "isLegacyAttribute" : true, + "name" : "...", + "type" : "..." }, + "propagateTags" : "BOTH", + "relationshipCategory" : "ASSOCIATION", "relationshipLabel" : "...", "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", + "cardinality" : "LIST", "constraints" : [ { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } + }, + "type" : "..." }, { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } - } ] - }, { + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", + "valuesMinCount" : 12345 + }, { + "cardinality" : "LIST", "constraints" : [ { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } + }, + "type" : "..." }, { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } - } ] + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeName" : "...", + "valuesMaxCount" : 12345, + "valuesMinCount" : 12345 } ], - "category" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", + "category" : "CLASSIFICATION", "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", + "createdBy" : "...", + "dateFormatter" : { + "availableLocales" : [ "...", "..." ], + "calendar" : 12345, + "dateInstance" : { }, + "dateTimeInstance" : { }, + "instance" : { }, + "lenient" : true, + "numberFormat" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "HALF_DOWN" + }, + "timeInstance" : { }, + "timeZone" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + } + }, "description" : "...", - "typeVersion" : "...", + "guid" : "...", + "name" : "...", "options" : { "property1" : "...", "property2" : "..." - } + }, + "typeVersion" : "...", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasRelationshipEndDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelationshipEndDef.html b/1.1.0/api/v2/json_AtlasRelationshipEndDef.html index 998d349..1c9d831 100644 --- a/1.1.0/api/v2/json_AtlasRelationshipEndDef.html +++ b/1.1.0/api/v2/json_AtlasRelationshipEndDef.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -80,16 +80,16 @@ attribute name, cardinality and whether it is the container end of the relation </thead> <tbody> <tr> - <td> <span class="property-name">type</span> + <td> <span id="prop-cardinality" class="property-name">cardinality</span> </td> - <td> <span class="datatype-reference">string + <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">name</span> + <td> <span id="prop-description" class="property-name">description</span> </td> <td> <span class="datatype-reference">string </span> @@ -98,7 +98,7 @@ attribute name, cardinality and whether it is the container end of the relation </td> </tr> <tr> - <td> <span class="property-name">isContainer</span> + <td> <span id="prop-isContainer" class="property-name">isContainer</span> </td> <td> <span class="datatype-reference">boolean </span> @@ -107,18 +107,27 @@ attribute name, cardinality and whether it is the container end of the relation </td> </tr> <tr> - <td> <span class="property-name">cardinality</span> + <td> <span id="prop-isLegacyAttribute" class="property-name">isLegacyAttribute</span> </td> - <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a> + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">isLegacyAttribute</span> + <td> <span id="prop-name" class="property-name">name</span> </td> - <td> <span class="datatype-reference">boolean + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-type" class="property-name">type</span> +</td> + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -130,11 +139,12 @@ attribute name, cardinality and whether it is the container end of the relation <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "type" : "...", - "name" : "...", + "cardinality" : "LIST", + "description" : "...", "isContainer" : true, - "cardinality" : "SET", - "isLegacyAttribute" : true + "isLegacyAttribute" : true, + "name" : "...", + "type" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasRelationshipWithExtInfo.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasRelationshipWithExtInfo.html b/1.1.0/api/v2/json_AtlasRelationshipWithExtInfo.html new file mode 100644 index 0000000..ade35de --- /dev/null +++ b/1.1.0/api/v2/json_AtlasRelationshipWithExtInfo.html @@ -0,0 +1,335 @@ +<!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: AtlasRelationshipWithExtInfo</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/enunciate.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelationshipWithExtInfo</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_AtlasRelationshipWithExtInfo.html">AtlasRelationshipWithExtInfo</a></li> + </ol> + + <h1 class="page-header">AtlasRelationshipWithExtInfo <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 id="prop-referredEntities" 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> + <tr> + <td> <span id="prop-relationship" class="property-name">relationship</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "referredEntities" : { + "property1" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "property2" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } + }, + "relationship" : { + "blockedPropagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "guid" : "...", + "homeId" : "...", + "label" : "...", + "propagateTags" : "ONE_TO_TWO", + "propagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "status" : "DELETED", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } +}</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/3fad5df3/1.1.0/api/v2/json_AtlasSearchResult.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasSearchResult.html b/1.1.0/api/v2/json_AtlasSearchResult.html index 0b95d99..47100c5 100644 --- a/1.1.0/api/v2/json_AtlasSearchResult.html +++ b/1.1.0/api/v2/json_AtlasSearchResult.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -79,43 +79,43 @@ </thead> <tbody> <tr> - <td> <span class="property-name">queryType</span> + <td> <span id="prop-attributes" class="property-name">attributes</span> </td> - <td> <span class="datatype-reference"><a href="json_AtlasQueryType.html">AtlasQueryType</a> + <td> <span class="datatype-reference"><a href="json_AttributeSearchResult.html">AttributeSearchResult</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">searchParameters</span> + <td> <span id="prop-classification" class="property-name">classification</span> </td> - <td> <span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a> + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">queryText</span> + <td> <span id="prop-entities" class="property-name">entities</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">array of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">type</span> + <td> <span id="prop-fullTextResult" class="property-name">fullTextResult</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">array of <a href="json_AtlasFullTextResult.html">AtlasFullTextResult</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">classification</span> + <td> <span id="prop-queryText" class="property-name">queryText</span> </td> <td> <span class="datatype-reference">string </span> @@ -124,36 +124,36 @@ </td> </tr> <tr> - <td> <span class="property-name">entities</span> + <td> <span id="prop-queryType" class="property-name">queryType</span> </td> - <td> <span class="datatype-reference">array of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> + <td> <span class="datatype-reference"><a href="json_AtlasQueryType.html">AtlasQueryType</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">attributes</span> + <td> <span id="prop-referredEntities" class="property-name">referredEntities</span> </td> - <td> <span class="datatype-reference"><a href="json_AttributeSearchResult.html">AttributeSearchResult</a> + <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">fullTextResult</span> + <td> <span id="prop-searchParameters" class="property-name">searchParameters</span> </td> - <td> <span class="datatype-reference">array of <a href="json_AtlasFullTextResult.html">AtlasFullTextResult</a> + <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">referredEntities</span> + <td> <span id="prop-type" class="property-name">type</span> </td> - <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -165,109 +165,307 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "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" : [ "...", "..." ] + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] }, - "queryText" : "...", - "type" : "...", "classification" : "...", "entities" : [ { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + } ], "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } ], - "attributes" : { - "name" : [ "...", "..." ], - "values" : [ ] - }, "fullTextResult" : [ { "entity" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", "classificationNames" : [ "...", "..." ], - "typeName" : "...", + "classifications" : [ { }, { } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { }, { } ], + "status" : "DELETED", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, "score" : 12345.0 }, { "entity" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", "classificationNames" : [ "...", "..." ], - "typeName" : "...", + "classifications" : [ { }, { } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { }, { } ], + "status" : "ACTIVE", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, "score" : 12345.0 } ], + "queryText" : "...", + "queryType" : "DSL", "referredEntities" : { "property1" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + } ], "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, "property2" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", "classificationNames" : [ "...", "..." ], - "typeName" : "...", + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "ACTIVE", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } - } + }, + "searchParameters" : { + "attributes" : [ "...", "..." ], + "classification" : "...", + "entityFilters" : { + "attributeName" : "...", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ], + "operator" : "GTE" + }, + "excludeDeletedEntities" : true, + "includeClassificationAttributes" : true, + "includeSubClassifications" : true, + "includeSubTypes" : true, + "limit" : 12345, + "offset" : 12345, + "query" : "...", + "tagFilters" : { + "attributeName" : "...", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ], + "operator" : "NOT_NULL" + }, + "termName" : "...", + "typeName" : "..." + }, + "type" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasStruct.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasStruct.html b/1.1.0/api/v2/json_AtlasStruct.html index 34f0ba9..7ebba99 100644 --- a/1.1.0/api/v2/json_AtlasStruct.html +++ b/1.1.0/api/v2/json_AtlasStruct.html @@ -67,7 +67,7 @@ <dl class="dl-horizontal"> <dt>Subtypes</dt> - <dd><a href="json_AtlasClassification.html">AtlasClassification</a></dd> + <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasClassification.html">AtlasClassification</a>, <a href="json_AtlasRelationship.html">AtlasRelationship</a>, <a href="json_AtlasEntity.html">AtlasEntity</a></dd> </dl> <table class="table datatype-properties"> @@ -81,18 +81,18 @@ </thead> <tbody> <tr> - <td> <span class="property-name">typeName</span> + <td> <span id="prop-attributes" class="property-name">attributes</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">map of object </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">attributes</span> + <td> <span id="prop-typeName" class="property-name">typeName</span> </td> - <td> <span class="datatype-reference">map of object + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -104,11 +104,11 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer">
