http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasGlossaryTerm.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasGlossaryTerm.html b/1.0.0/api/v2/json_AtlasGlossaryTerm.html new file mode 100644 index 0000000..99e2425 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasGlossaryTerm.html @@ -0,0 +1,686 @@ +<!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: AtlasGlossaryTerm</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: AtlasGlossaryTerm</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_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a></li> + </ol> + + <h1 class="page-header">AtlasGlossaryTerm <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-abbreviation" class="property-name">abbreviation</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-anchor" class="property-name">anchor</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasGlossaryHeader.html">AtlasGlossaryHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-antonyms" class="property-name">antonyms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-assignedEntities" class="property-name">assignedEntities</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-categories" class="property-name">categories</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasTermCategorizationHeader.html">AtlasTermCategorizationHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-classifies" class="property-name">classifies</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-examples" class="property-name">examples</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-isA" class="property-name">isA</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-preferredTerms" class="property-name">preferredTerms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-preferredToTerms" class="property-name">preferredToTerms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-replacedBy" class="property-name">replacedBy</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-replacementTerms" class="property-name">replacementTerms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-seeAlso" class="property-name">seeAlso</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-synonyms" class="property-name">synonyms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-translatedTerms" class="property-name">translatedTerms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-translationTerms" class="property-name">translationTerms</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-usage" class="property-name">usage</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-validValues" class="property-name">validValues</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-validValuesFor" class="property-name">validValuesFor</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</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_AtlasGlossaryBaseObject.html">AtlasGlossaryBaseObject</a></h5></td> + </tr> + <tbody> + <tr> + <td><span 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 class="property-name">longDescription</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">qualifiedName</span></td> + <td><span class="datatype-reference">string +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">shortDescription</span></td> + <td><span class="datatype-reference">string +</span></td> + <td><span class="property-description"></span></td> + </tr> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseModelObject.html">AtlasBaseModelObject</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> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "abbreviation" : "...", + "anchor" : { + "displayText" : "...", + "glossaryGuid" : "...", + "relationGuid" : "..." + }, + "antonyms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "ACTIVE", + "steward" : "...", + "termGuid" : "..." + } ], + "assignedEntities" : [ { + "displayText" : "...", + "entityStatus" : "DELETED", + "relationshipAttributes" : { + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "relationshipGuid" : "...", + "relationshipStatus" : "ACTIVE", + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "displayText" : "...", + "entityStatus" : "ACTIVE", + "relationshipAttributes" : { + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "relationshipGuid" : "...", + "relationshipStatus" : "DELETED", + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "categories" : [ { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "relationGuid" : "...", + "status" : "OTHER" + }, { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "relationGuid" : "...", + "status" : "OTHER" + } ], + "classifies" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "ACTIVE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "examples" : [ "...", "..." ], + "isA" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "preferredTerms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "ACTIVE", + "steward" : "...", + "termGuid" : "..." + } ], + "preferredToTerms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "replacedBy" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "replacementTerms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "seeAlso" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "synonyms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "translatedTerms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "translationTerms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "ACTIVE", + "steward" : "...", + "termGuid" : "..." + } ], + "usage" : "...", + "validValues" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "validValuesFor" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "classifications" : [ { + "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" : "..." + } ], + "longDescription" : "...", + "name" : "...", + "qualifiedName" : "...", + "shortDescription" : "...", + "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_AtlasLineageInfo.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasLineageInfo.html b/1.0.0/api/v2/json_AtlasLineageInfo.html new file mode 100644 index 0000000..b252875 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasLineageInfo.html @@ -0,0 +1,295 @@ +<!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: AtlasLineageInfo</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: AtlasLineageInfo</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_AtlasLineageInfo.html">AtlasLineageInfo</a></li> + </ol> + + <h1 class="page-header">AtlasLineageInfo <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-baseEntityGuid" class="property-name">baseEntityGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-guidEntityMap" class="property-name">guidEntityMap</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-lineageDepth" class="property-name">lineageDepth</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-lineageDirection" class="property-name">lineageDirection</span> +</td> + <td> <span class="datatype-reference"><a href="json_LineageDirection.html">LineageDirection</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relations" class="property-name">relations</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_LineageRelation.html">LineageRelation</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "baseEntityGuid" : "...", + "guidEntityMap" : { + "property1" : { + "classificationNames" : [ "...", "..." ], + "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" : "..." + } ], + "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" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "ACTIVE", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } + }, + "lineageDepth" : 12345, + "lineageDirection" : "INPUT", + "relations" : [ { + "fromEntityId" : "...", + "relationshipId" : "...", + "toEntityId" : "..." + }, { + "fromEntityId" : "...", + "relationshipId" : "...", + "toEntityId" : "..." + } ] +}</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_AtlasObjectId.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasObjectId.html b/1.0.0/api/v2/json_AtlasObjectId.html new file mode 100644 index 0000000..508bb21 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasObjectId.html @@ -0,0 +1,155 @@ +<!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: AtlasObjectId</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: AtlasObjectId</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_AtlasObjectId.html">AtlasObjectId</a></li> + </ol> + + <h1 class="page-header">AtlasObjectId <small>Data Type</small></h1> + + <p>Reference to an object-instance of an Atlas type - like entity.</p> + + <dl class="dl-horizontal"> + <dt>Subtypes</dt> + <dd><a href="json_AtlasRelatedObjectId.html">AtlasRelatedObjectId</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> + <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-uniqueAttributes" 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">{ + "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.0.0/api/v2/json_AtlasQueryType.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasQueryType.html b/1.0.0/api/v2/json_AtlasQueryType.html new file mode 100644 index 0000000..c8f709f --- /dev/null +++ b/1.0.0/api/v2/json_AtlasQueryType.html @@ -0,0 +1,145 @@ +<!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: AtlasQueryType</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: AtlasQueryType</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li><a href="#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> + + <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_AtlasQueryType.html">AtlasQueryType</a></li> + </ol> + + <h1 class="page-header">AtlasQueryType <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-values"> + <caption>Values</caption> + <thead> + <tr> + <th>value</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="value-value" id="DSL">DSL</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <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" id="GREMLIN">GREMLIN</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="BASIC">BASIC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <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> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com";>Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"; type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasRelatedCategoryHeader.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelatedCategoryHeader.html b/1.0.0/api/v2/json_AtlasRelatedCategoryHeader.html new file mode 100644 index 0000000..c90ead7 --- /dev/null +++ b/1.0.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.0.0/api/v2/json_AtlasRelatedObjectId.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelatedObjectId.html b/1.0.0/api/v2/json_AtlasRelatedObjectId.html new file mode 100644 index 0000000..22fe609 --- /dev/null +++ b/1.0.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.0.0/api/v2/json_AtlasRelatedTermHeader.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelatedTermHeader.html b/1.0.0/api/v2/json_AtlasRelatedTermHeader.html new file mode 100644 index 0000000..9dd5e94 --- /dev/null +++ b/1.0.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.0.0/api/v2/json_AtlasRelationship.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelationship.html b/1.0.0/api/v2/json_AtlasRelationship.html new file mode 100644 index 0000000..89e0f11 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasRelationship.html @@ -0,0 +1,372 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasRelationship</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/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: AtlasRelationship</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasRelationship.html">AtlasRelationship</a></li> + </ol> + + <h1 class="page-header">AtlasRelationship <small>Data Type</small></h1> + + <p>Atlas relationship instance.</p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span 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> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-end1" class="property-name">end1</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasObjectId.html">AtlasObjectId</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span 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> +</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-label" class="property-name">label</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-propagateTags" class="property-name">propagateTags</span> +</td> + <td> <span class="datatype-reference"><a href="json_PropagateTags.html">PropagateTags</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-propagatedClassifications" class="property-name">propagatedClassifications</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-status" class="property-name">status</span> +</td> + <td> <span class="datatype-reference"><a href="json_Status_AtlasRelationship.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span 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">{ + "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, + "createdBy" : "...", + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "guid" : "...", + "homeId" : "...", + "label" : "...", + "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"> + <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>
