http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasRelationshipDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelationshipDef.html b/1.0.0/api/v2/json_AtlasRelationshipDef.html new file mode 100644 index 0000000..16d58a4 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasRelationshipDef.html @@ -0,0 +1,408 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasRelationshipDef</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/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: AtlasRelationshipDef</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a></li> + </ol> + + <h1 class="page-header">AtlasRelationshipDef <small>Data Type</small></h1> + + <p>AtlasRelationshipDef is a TypeDef that defines a relationship. +<p> +As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. +The name and the guid are the 2 ways that the RelationshipDef is identified. +<p> +RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally +whether the end is a container. +<p> +RelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br> +RelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br> +RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships. +<p> +The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs +will not specify an EntityDef type name as their types. +<p> +RelationshipDefs introduce new atributes to the entity instances. For example +<p> +EntityDef A might have attributes attr1,attr2,attr3 <br> +EntityDef B might have attributes attr4,attr5,attr6 <br> +RelationshipDef AtoB might define 2 ends <br> + +<pre> + end1: type A, name attr7 + end2: type B, name attr8 </pre> + +<p> +When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br> +When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 +<p> +In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into +the entity instances</p> + + <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-endDef1" class="property-name">endDef1</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-endDef2" class="property-name">endDef2</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span 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-relationshipCategory" class="property-name">relationshipCategory</span> +</td> + <td> <span class="datatype-reference"><a href="json_RelationshipCategory.html">RelationshipCategory</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationshipLabel" class="property-name">relationshipLabel</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStructDef.html">AtlasStructDef</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">attributeDefs</span></td> + <td><span class="datatype-reference">array of <a href="json_AtlasAttributeDef.html">AtlasAttributeDef</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">category</span></td> + <td><span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">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">{ + "endDef1" : { + "cardinality" : "SET", + "description" : "...", + "isContainer" : true, + "isLegacyAttribute" : true, + "name" : "...", + "type" : "..." + }, + "endDef2" : { + "cardinality" : "LIST", + "description" : "...", + "isContainer" : true, + "isLegacyAttribute" : true, + "name" : "...", + "type" : "..." + }, + "propagateTags" : "BOTH", + "relationshipCategory" : "ASSOCIATION", + "relationshipLabel" : "...", + "attributeDefs" : [ { + "cardinality" : "LIST", + "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" : "LIST", + "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" : "CLASSIFICATION", + "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" : "HALF_DOWN" + }, + "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_AtlasRelationshipEndDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelationshipEndDef.html b/1.0.0/api/v2/json_AtlasRelationshipEndDef.html new file mode 100644 index 0000000..1c9d831 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasRelationshipEndDef.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasRelationshipEndDef</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/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: AtlasRelationshipEndDef</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasRelationshipEndDef.html">AtlasRelationshipEndDef</a></li> + </ol> + + <h1 class="page-header">AtlasRelationshipEndDef <small>Data Type</small></h1> + + <p>The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship.</p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span 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-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-isContainer" class="property-name">isContainer</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-isLegacyAttribute" class="property-name">isLegacyAttribute</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-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">{ + "cardinality" : "LIST", + "description" : "...", + "isContainer" : true, + "isLegacyAttribute" : true, + "name" : "...", + "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_AtlasRelationshipWithExtInfo.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasRelationshipWithExtInfo.html b/1.0.0/api/v2/json_AtlasRelationshipWithExtInfo.html new file mode 100644 index 0000000..ade35de --- /dev/null +++ b/1.0.0/api/v2/json_AtlasRelationshipWithExtInfo.html @@ -0,0 +1,335 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasRelationshipWithExtInfo</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/enunciate.css"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> +</head> + +<body data-spy="scroll" data-target="#apinav"> + + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Atlas REST API: AtlasRelationshipWithExtInfo</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasRelationshipWithExtInfo.html">AtlasRelationshipWithExtInfo</a></li> + </ol> + + <h1 class="page-header">AtlasRelationshipWithExtInfo <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span id="prop-referredEntities" class="property-name">referredEntities</span> +</td> + <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-relationship" class="property-name">relationship</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "referredEntities" : { + "property1" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "property2" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } + }, + "relationship" : { + "blockedPropagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "guid" : "...", + "homeId" : "...", + "label" : "...", + "propagateTags" : "ONE_TO_TWO", + "propagatedClassifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "status" : "DELETED", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } +}</pre> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com";>Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"; type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasSearchResult.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasSearchResult.html b/1.0.0/api/v2/json_AtlasSearchResult.html new file mode 100644 index 0000000..47100c5 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasSearchResult.html @@ -0,0 +1,502 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasSearchResult</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: AtlasSearchResult</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_AtlasSearchResult.html">AtlasSearchResult</a></li> + </ol> + + <h1 class="page-header">AtlasSearchResult <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-attributes" class="property-name">attributes</span> +</td> + <td> <span class="datatype-reference"><a href="json_AttributeSearchResult.html">AttributeSearchResult</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-classification" class="property-name">classification</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-entities" class="property-name">entities</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-fullTextResult" class="property-name">fullTextResult</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasFullTextResult.html">AtlasFullTextResult</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-queryText" class="property-name">queryText</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-queryType" class="property-name">queryType</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasQueryType.html">AtlasQueryType</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-referredEntities" class="property-name">referredEntities</span> +</td> + <td> <span class="datatype-reference">map of <a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-searchParameters" class="property-name">searchParameters</span> +</td> + <td> <span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span 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">{ + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "classification" : "...", + "entities" : [ { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "ACTIVE", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "ACTIVE", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "fullTextResult" : [ { + "entity" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { }, { } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { }, { } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "score" : 12345.0 + }, { + "entity" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { }, { } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { }, { } ], + "status" : "ACTIVE", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "score" : 12345.0 + } ], + "queryText" : "...", + "queryType" : "DSL", + "referredEntities" : { + "property1" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, + "property2" : { + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "ACTIVE", + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } + }, + "searchParameters" : { + "attributes" : [ "...", "..." ], + "classification" : "...", + "entityFilters" : { + "attributeName" : "...", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ], + "operator" : "GTE" + }, + "excludeDeletedEntities" : true, + "includeClassificationAttributes" : true, + "includeSubClassifications" : true, + "includeSubTypes" : true, + "limit" : 12345, + "offset" : 12345, + "query" : "...", + "tagFilters" : { + "attributeName" : "...", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ], + "operator" : "NOT_NULL" + }, + "termName" : "...", + "typeName" : "..." + }, + "type" : "..." +}</pre> + + <footer class="footer"> + <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_AtlasStruct.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasStruct.html b/1.0.0/api/v2/json_AtlasStruct.html index 34f0ba9..7ebba99 100644 --- a/1.0.0/api/v2/json_AtlasStruct.html +++ b/1.0.0/api/v2/json_AtlasStruct.html @@ -67,7 +67,7 @@ <dl class="dl-horizontal"> <dt>Subtypes</dt> - <dd><a href="json_AtlasClassification.html">AtlasClassification</a></dd> + <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasClassification.html">AtlasClassification</a>, <a href="json_AtlasRelationship.html">AtlasRelationship</a>, <a href="json_AtlasEntity.html">AtlasEntity</a></dd> </dl> <table class="table datatype-properties"> @@ -81,18 +81,18 @@ </thead> <tbody> <tr> - <td> <span class="property-name">typeName</span> + <td> <span id="prop-attributes" class="property-name">attributes</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">map of object </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">attributes</span> + <td> <span id="prop-typeName" class="property-name">typeName</span> </td> - <td> <span class="datatype-reference">map of object + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -104,11 +104,11 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.0.0/api/v2/json_AtlasStructDef.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasStructDef.html b/1.0.0/api/v2/json_AtlasStructDef.html new file mode 100644 index 0000000..decd0f7 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasStructDef.html @@ -0,0 +1,314 @@ +<!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: AtlasStructDef</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: AtlasStructDef</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_AtlasStructDef.html">AtlasStructDef</a></li> + </ol> + + <h1 class="page-header">AtlasStructDef <small>Data Type</small></h1> + + <p>class that captures details of a struct-type.</p> + + <dl class="dl-horizontal"> + <dt>Subtypes</dt> + <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_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-attributeDefs" 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">{ + "attributeDefs" : [ { + "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 + }, { + "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 + } ], + "category" : "RELATIONSHIP", + "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" : "FLOOR" + }, + "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_AtlasTermAssignmentHeader.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasTermAssignmentHeader.html b/1.0.0/api/v2/json_AtlasTermAssignmentHeader.html new file mode 100644 index 0000000..3e2df53 --- /dev/null +++ b/1.0.0/api/v2/json_AtlasTermAssignmentHeader.html @@ -0,0 +1,220 @@ +<!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: AtlasTermAssignmentHeader</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: AtlasTermAssignmentHeader</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_AtlasTermAssignmentHeader.html">AtlasTermAssignmentHeader</a></li> + </ol> + + <h1 class="page-header">AtlasTermAssignmentHeader <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-confidence" class="property-name">confidence</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-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_AtlasTermAssignmentStatus.html">AtlasTermAssignmentStatus</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">{ + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "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_AtlasTermAssignmentStatus.html ---------------------------------------------------------------------- diff --git a/1.0.0/api/v2/json_AtlasTermAssignmentStatus.html b/1.0.0/api/v2/json_AtlasTermAssignmentStatus.html new file mode 100644 index 0000000..b13a2ff --- /dev/null +++ b/1.0.0/api/v2/json_AtlasTermAssignmentStatus.html @@ -0,0 +1,150 @@ +<!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: AtlasTermAssignmentStatus</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: AtlasTermAssignmentStatus</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="#DISCOVERED"><abbr title="DISCOVERED"><span class="sideoverflow">DISCOVERED</span></abbr></a></li> + <li><a href="#PROPOSED"><abbr title="PROPOSED"><span class="sideoverflow">PROPOSED</span></abbr></a></li> + <li><a href="#IMPORTED"><abbr title="IMPORTED"><span class="sideoverflow">IMPORTED</span></abbr></a></li> + <li><a href="#VALIDATED"><abbr title="VALIDATED"><span class="sideoverflow">VALIDATED</span></abbr></a></li> + <li><a href="#DEPRECATED"><abbr title="DEPRECATED"><span class="sideoverflow">DEPRECATED</span></abbr></a></li> + <li><a href="#OBSOLETE"><abbr title="OBSOLETE"><span class="sideoverflow">OBSOLETE</span></abbr></a></li> + <li><a href="#OTHER"><abbr title="OTHER"><span class="sideoverflow">OTHER</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_AtlasTermAssignmentStatus.html">AtlasTermAssignmentStatus</a></li> + </ol> + + <h1 class="page-header">AtlasTermAssignmentStatus <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="DISCOVERED">DISCOVERED</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="PROPOSED">PROPOSED</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="IMPORTED">IMPORTED</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="VALIDATED">VALIDATED</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="DEPRECATED">DEPRECATED</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="OBSOLETE">OBSOLETE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="OTHER">OTHER</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>
