http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasAttributeDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasAttributeDef.html b/1.0.0/api/v2/json_AtlasAttributeDef.html new file mode 100644 index 0000000..ef93a3a --- /dev/null +++ b/1.0.0/api/v2/json_AtlasAttributeDef.html @@ -0,0 +1,265 @@ +<!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: AtlasAttributeDef</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: AtlasAttributeDef</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_AtlasAttributeDef.html">AtlasAttributeDef</a></li> + </ol> + + <h1 class="page-header">AtlasAttributeDef <small>Data Type</small></h1> + + <p>class that captures details of a struct-attribute.</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-cardinality" 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 id="prop-constraints" class="property-name">constraints</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-defaultValue" 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 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-includeInNotification" class="property-name">includeInNotification</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-isIndexable" class="property-name">isIndexable</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-isOptional" class="property-name">isOptional</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-isUnique" class="property-name">isUnique</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-name" 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 id="prop-options" 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 id="prop-typeName" 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 id="prop-valuesMaxCount" class="property-name">valuesMaxCount</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-valuesMinCount" class="property-name">valuesMinCount</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "cardinality" : "SET", + "constraints" : [ { + "params" : { + "property1" : { }, + "property2" : { } + }, + "type" : "..." + }, { + "params" : { + "property1" : { }, + "property2" : { } + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeName" : "...", + "valuesMaxCount" : 12345, + "valuesMinCount" : 12345 +}</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.0.0/api/v2/json_AtlasBaseModelObject.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasBaseModelObject.html b/1.0.0/api/v2/json_AtlasBaseModelObject.html new file mode 100644 index 0000000..322057b --- /dev/null +++ b/1.0.0/api/v2/json_AtlasBaseModelObject.html @@ -0,0 +1,136 @@ +<!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: AtlasBaseModelObject</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: AtlasBaseModelObject</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_AtlasBaseModelObject.html">AtlasBaseModelObject</a></li> + </ol> + + <h1 class="page-header">AtlasBaseModelObject <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + <dt>Subtypes</dt> + <dd><a href="json_AtlasGlossaryBaseObject.html">AtlasGlossaryBaseObject</a>, <a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>, <a href="json_AtlasGlossary.html">AtlasGlossary</a>, <a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>, <a href="json_AtlasGlossaryExtInfo.html">AtlasGlossaryExtInfo</a>, <a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a></dd> + </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-guid" class="property-name">guid</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> + + <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">{ + "guid" : "..." +}</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.0.0/api/v2/json_AtlasBaseTypeDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasBaseTypeDef.html b/1.0.0/api/v2/json_AtlasBaseTypeDef.html new file mode 100644 index 0000000..c7859f5 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasBaseTypeDef.html @@ -0,0 +1,281 @@ +<!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: AtlasBaseTypeDef</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: AtlasBaseTypeDef</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_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></li> + </ol> + + <h1 class="page-header">AtlasBaseTypeDef <small>Data Type</small></h1> + + <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_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd> + </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-category" 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 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> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-dateFormatter" 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 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-guid" 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 id="prop-name" 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 id="prop-options" 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 id="prop-typeVersion" 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 id="prop-updateTime" 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 id="prop-updatedBy" 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 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> + </table> + + <p class="lead">Example</p> + + <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", + "createTime" : 12345, + "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" : "UNNECESSARY" + }, + "timeInstance" : { }, + "timeZone" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + } + }, + "description" : "...", + "guid" : "...", + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeVersion" : "...", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345 +}</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.0.0/api/v2/json_AtlasClassification.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasClassification.html b/1.0.0/api/v2/json_AtlasClassification.html index e743429..6a33e25 100644 --- a/1.0.0/api/v2/json_AtlasClassification.html +++ b/1.0.0/api/v2/json_AtlasClassification.html @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">entityGuid</span> + <td> <span id="prop-entityGuid" class="property-name">entityGuid</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,7 +88,16 @@ </td> </tr> <tr> - <td> <span class="property-name">propagate</span> + <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-propagate" class="property-name">propagate</span> </td> <td> <span class="datatype-reference">boolean </span> @@ -97,7 +106,16 @@ </td> </tr> <tr> - <td> <span class="property-name">validityPeriods</span> + <td> <span id="prop-removePropagationsOnEntityDelete" class="property-name">removePropagationsOnEntityDelete</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-validityPeriods" class="property-name">validityPeriods</span> </td> <td> <span class="datatype-reference">array of <a href="json_TimeBoundary.html">TimeBoundary</a> </span> @@ -111,14 +129,14 @@ </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> @@ -129,21 +147,23 @@ <pre class="prettyprint language-js example">{ "entityGuid" : "...", + "entityStatus" : "ACTIVE", "propagate" : true, + "removePropagationsOnEntityDelete" : true, "validityPeriods" : [ { - "startTime" : "...", "endTime" : "...", + "startTime" : "...", "timeZone" : "..." }, { - "startTime" : "...", "endTime" : "...", + "startTime" : "...", "timeZone" : "..." } ], - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasClassificationDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasClassificationDef.html b/1.0.0/api/v2/json_AtlasClassificationDef.html new file mode 100644 index 0000000..9e76fea --- /dev/null +++ b/1.0.0/api/v2/json_AtlasClassificationDef.html @@ -0,0 +1,353 @@ +<!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: AtlasClassificationDef</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: AtlasClassificationDef</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_AtlasClassificationDef.html">AtlasClassificationDef</a></li> + </ol> + + <h1 class="page-header">AtlasClassificationDef <small>Data Type</small></h1> + + <p>class that captures details of a classification-type.</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-entityTypes" class="property-name">entityTypes</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description">Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul></span> +</td> + </tr> + <tr> + <td> <span id="prop-subTypes" class="property-name">subTypes</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-superTypes" class="property-name">superTypes</span> +</td> + <td> <span class="datatype-reference">array of 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">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">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">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">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">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">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">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">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">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">version</span></td> + <td><span class="datatype-reference">number +</span></td> + <td><span class="property-description"></span></td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "entityTypes" : [ "...", "..." ], + "subTypes" : [ "...", "..." ], + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "cardinality" : "SINGLE", + "constraints" : [ { + "params" : { + "property1" : { }, + "property2" : { } + }, + "type" : "..." + }, { + "params" : { + "property1" : { }, + "property2" : { } + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeName" : "...", + "valuesMaxCount" : 12345, + "valuesMinCount" : 12345 + }, { + "cardinality" : "SINGLE", + "constraints" : [ { + "params" : { + "property1" : { }, + "property2" : { } + }, + "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", + "createTime" : 12345, + "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" : "UNNECESSARY" + }, + "timeInstance" : { }, + "timeZone" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + } + }, + "description" : "...", + "guid" : "...", + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeVersion" : "...", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345 +}</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.0.0/api/v2/json_AtlasClassifications.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasClassifications.html b/1.0.0/api/v2/json_AtlasClassifications.html new file mode 100644 index 0000000..d4b632a --- /dev/null +++ b/1.0.0/api/v2/json_AtlasClassifications.html @@ -0,0 +1,167 @@ +<!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: AtlasClassifications</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: AtlasClassifications</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_AtlasClassifications.html">AtlasClassifications</a></li> + </ol> + + <h1 class="page-header">AtlasClassifications <small>Data Type</small></h1> + + <p>REST serialization friendly list.</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> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_PList.html">PList</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">list</span></td> + <td><span class="datatype-reference">array of object +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">pageSize</span></td> + <td><span class="datatype-reference">number +</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-description"></span></td> + </tr> + <tr> + <td><span class="property-name">sortType</span></td> + <td><span class="datatype-reference"><a href="json_SortType.html">SortType</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">startIndex</span></td> + <td><span class="datatype-reference">number +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">totalCount</span></td> + <td><span class="datatype-reference">number +</span></td> + <td><span class="property-description"></span></td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "list" : [ { }, { } ], + "pageSize" : 12345, + "sortBy" : "...", + "sortType" : "ASC", + "startIndex" : 12345, + "totalCount" : 12345 +}</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.0.0/api/v2/json_AtlasConstraintDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasConstraintDef.html b/1.0.0/api/v2/json_AtlasConstraintDef.html new file mode 100644 index 0000000..e0965b9 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasConstraintDef.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: AtlasConstraintDef</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: AtlasConstraintDef</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_AtlasConstraintDef.html">AtlasConstraintDef</a></li> + </ol> + + <h1 class="page-header">AtlasConstraintDef <small>Data Type</small></h1> + + <p>class that captures details of a constraint.</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-params" class="property-name">params</span> +</td> + <td> <span class="datatype-reference">map of object +</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> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "params" : { + "property1" : { }, + "property2" : { } + }, + "type" : "..." +}</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.0.0/api/v2/json_AtlasEntitiesWithExtInfo.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasEntitiesWithExtInfo.html b/1.0.0/api/v2/json_AtlasEntitiesWithExtInfo.html new file mode 100644 index 0000000..ad39601 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasEntitiesWithExtInfo.html @@ -0,0 +1,405 @@ +<!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: AtlasEntitiesWithExtInfo</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: AtlasEntitiesWithExtInfo</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a></li> + </ol> + + <h1 class="page-header">AtlasEntitiesWithExtInfo <small>Data Type</small></h1> + + <p>An instance of an entity along with extended info - like hive_table, hive_database.</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-entities" class="property-name">entities</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasEntity.html">AtlasEntity</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_AtlasEntityExtInfo.html">AtlasEntityExtInfo</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">referredEntities</span></td> + <td><span class="datatype-reference">map of <a href="json_AtlasEntity.html">AtlasEntity</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "entities" : [ { + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "DELETED", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "DELETED", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "referredEntities" : { + "property1" : { + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "property2" : { + "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" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "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.0.0/api/v2/json_AtlasEntity.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasEntity.html b/1.0.0/api/v2/json_AtlasEntity.html new file mode 100644 index 0000000..bf80995 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasEntity.html @@ -0,0 +1,325 @@ +<!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: AtlasEntity</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: AtlasEntity</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_AtlasEntity.html">AtlasEntity</a></li> + </ol> + + <h1 class="page-header">AtlasEntity <small>Data Type</small></h1> + + <p>An instance of an entity - like hive_table, hive_database.</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-classifications" class="property-name">classifications</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> +</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> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-homeId" class="property-name">homeId</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-meanings" class="property-name">meanings</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasTermAssignmentHeader.html">AtlasTermAssignmentHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-proxy" class="property-name">proxy</span> +</td> + <td> <span class="datatype-reference">boolean +</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">map of object +</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_Status.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-updateTime" 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 id="prop-updatedBy" 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 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">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">typeName</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">{ + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "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" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "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>
