You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2017/02/18 01:53:50 UTC
[25/27] incubator-atlas-website git commit: Added V2 REST API
documentation (apoorvnaik via mneethiraj)
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasEnumDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumDef.html b/api/v2/json_AtlasEnumDef.html
new file mode 100644
index 0000000..bc81e81
--- /dev/null
+++ b/api/v2/json_AtlasEnumDef.html
@@ -0,0 +1,233 @@
+<!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: AtlasEnumDef</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasEnumDef</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_AtlasEnumDef.html">AtlasEnumDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasEnumDef <small>Data Type</small></h1>
+
+ <p>class that captures details of an enum-type.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">elementDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasEnumElementDef.html">AtlasEnumElementDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">defaultValue</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">category</span></td>
+ <td><span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">guid</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createdBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updatedBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updateTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">version</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">name</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">description</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">typeVersion</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">options</span></td>
+ <td><span class="datatype-reference">map of string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "STRUCT",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasEnumElementDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasEnumElementDef.html b/api/v2/json_AtlasEnumElementDef.html
new file mode 100644
index 0000000..768d224
--- /dev/null
+++ b/api/v2/json_AtlasEnumElementDef.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: AtlasEnumElementDef</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasEnumElementDef</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_AtlasEnumElementDef.html">AtlasEnumElementDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasEnumElementDef <small>Data Type</small></h1>
+
+ <p>class that captures details of an enum-element.</p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">value</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">description</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">ordinal</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">{
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasFullTextResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasFullTextResult.html b/api/v2/json_AtlasFullTextResult.html
new file mode 100644
index 0000000..1eeae75
--- /dev/null
+++ b/api/v2/json_AtlasFullTextResult.html
@@ -0,0 +1,162 @@
+<!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: AtlasFullTextResult</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasFullTextResult</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_AtlasFullTextResult.html">AtlasFullTextResult</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasFullTextResult <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">entity</span>
+</td>
+ <td> <span class="datatype-reference"><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">score</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">{
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+}</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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasLineageInfo.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasLineageInfo.html b/api/v2/json_AtlasLineageInfo.html
new file mode 100644
index 0000000..b509663
--- /dev/null
+++ b/api/v2/json_AtlasLineageInfo.html
@@ -0,0 +1,223 @@
+<!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/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: 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 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 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 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>
+ <tr>
+ <td> <span 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 class="property-name">lineageDepth</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">{
+ "baseEntityGuid" : "...",
+ "guidEntityMap" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ },
+ "relations" : [ {
+ "fromEntityId" : "...",
+ "toEntityId" : "..."
+ }, {
+ "fromEntityId" : "...",
+ "toEntityId" : "..."
+ } ],
+ "lineageDirection" : "OUTPUT",
+ "lineageDepth" : 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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasObjectId.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasObjectId.html b/api/v2/json_AtlasObjectId.html
new file mode 100644
index 0000000..a39f7cf
--- /dev/null
+++ b/api/v2/json_AtlasObjectId.html
@@ -0,0 +1,193 @@
+<!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/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: 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">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">guid</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">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>
+ <tr>
+ <td> <span class="property-name">validGuid</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">assignedGuid</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">unAssignedGuid</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">valid</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasQueryType.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasQueryType.html b/api/v2/json_AtlasQueryType.html
new file mode 100644
index 0000000..df10586
--- /dev/null
+++ b/api/v2/json_AtlasQueryType.html
@@ -0,0 +1,126 @@
+<!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/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: 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 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">DSL</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">FULL_TEXT</span></td>
+ <td><span class="value-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="value-value">GREMLIN</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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasSearchResult.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasSearchResult.html b/api/v2/json_AtlasSearchResult.html
new file mode 100644
index 0000000..5a601a2
--- /dev/null
+++ b/api/v2/json_AtlasSearchResult.html
@@ -0,0 +1,245 @@
+<!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/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: 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 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 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 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 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 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>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "queryText" : "...",
+ "queryType" : "DSL",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ]
+}</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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasStruct.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStruct.html b/api/v2/json_AtlasStruct.html
new file mode 100644
index 0000000..57a0687
--- /dev/null
+++ b/api/v2/json_AtlasStruct.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: AtlasStruct</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasStruct</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li><a href="resources.html">Resources</a></li>
+ <li><a href="data.html">Data Types</a></li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+
+ <div class="container-fluid">
+ <div class="row">
+ <div class="col-sm-3 col-md-2 sidebar" id="apinav">
+ <ul class="nav nav-sidebar">
+ <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
+ </ul>
+ </div>
+
+ <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
+ <ol class="breadcrumb" id="top">
+ <li class="active dropdown"><a href="index.html">Home</a></li>
+ <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
+ <li class="dropdown"><a href="json_AtlasStruct.html">AtlasStruct</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasStruct <small>Data Type</small></h1>
+
+ <p>Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</p>
+
+ <dl class="dl-horizontal">
+ <dt>Subtypes</dt>
+ <dd><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a>, <a href="json_AtlasEntity.html">AtlasEntity</a>, <a href="json_AtlasClassification.html">AtlasClassification</a></dd>
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">typeName</span>
+</td>
+ <td> <span class="datatype-reference">string
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">attributes</span>
+</td>
+ <td> <span class="datatype-reference">map of object
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasStructDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasStructDef.html b/api/v2/json_AtlasStructDef.html
new file mode 100644
index 0000000..35cac2f
--- /dev/null
+++ b/api/v2/json_AtlasStructDef.html
@@ -0,0 +1,261 @@
+<!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/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: 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_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 class="property-name">attributeDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasAttributeDef.html">AtlasAttributeDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ <tr>
+ <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></h5></td>
+ </tr>
+ <tbody>
+ <tr>
+ <td><span class="property-name">category</span></td>
+ <td><span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a>
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">guid</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createdBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updatedBy</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">createTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">updateTime</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">version</span></td>
+ <td><span class="datatype-reference">number
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">name</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">description</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">typeVersion</span></td>
+ <td><span class="datatype-reference">string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="property-name">options</span></td>
+ <td><span class="datatype-reference">map of string
+</span></td>
+ <td><span class="property-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasTypeDefHeader.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasTypeDefHeader.html b/api/v2/json_AtlasTypeDefHeader.html
new file mode 100644
index 0000000..954d7a1
--- /dev/null
+++ b/api/v2/json_AtlasTypeDefHeader.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: AtlasTypeDefHeader</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasTypeDefHeader</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_AtlasTypeDefHeader.html">AtlasTypeDefHeader</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasTypeDefHeader <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">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">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>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "guid" : "...",
+ "name" : "...",
+ "category" : "ENUM"
+}</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/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasTypesDef.html
----------------------------------------------------------------------
diff --git a/api/v2/json_AtlasTypesDef.html b/api/v2/json_AtlasTypesDef.html
new file mode 100644
index 0000000..a08594b
--- /dev/null
+++ b/api/v2/json_AtlasTypesDef.html
@@ -0,0 +1,440 @@
+<!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: AtlasTypesDef</title>
+
+ <!-- Mobile viewport optimized: j.mp/bplateviewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Bootstrap core CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+
+ <!--custom css for these pages-->
+ <link rel="stylesheet" href="css/style.css">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+<body data-spy="scroll" data-target="#apinav">
+
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="index.html">Atlas REST API: AtlasTypesDef</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_AtlasTypesDef.html">AtlasTypesDef</a></li>
+ </ol>
+
+ <h1 class="page-header">AtlasTypesDef <small>Data Type</small></h1>
+
+ <p></p>
+
+ <dl class="dl-horizontal">
+ </dl>
+
+ <table class="table datatype-properties">
+ <caption>Properties</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td> <span class="property-name">enumDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">structDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasStructDef.html">AtlasStructDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">classificationDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">entityDefs</span>
+</td>
+ <td> <span class="datatype-reference">array of <a href="json_AtlasEntityDef.html">AtlasEntityDef</a>
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ <tr>
+ <td> <span class="property-name">empty</span>
+</td>
+ <td> <span class="datatype-reference">boolean
+</span>
+</td>
+ <td> <span class="property-description"></span>
+</td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p class="lead">Example</p>
+
+ <pre class="prettyprint language-js example">{
+ "enumDefs" : [ {
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "elementDefs" : [ {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ }, {
+ "value" : "...",
+ "description" : "...",
+ "ordinal" : 12345
+ } ],
+ "defaultValue" : "...",
+ "category" : "MAP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "structDefs" : [ {
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ARRAY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "classificationDefs" : [ {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "MAP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "entityDefs" : [ {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SET",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENUM",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "LIST",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "ENTITY",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "empty" : true
+}</pre>
+
+ <footer class="footer">
+ <div class="container">
+ <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
+ </div>
+ </footer>
+
+ </div>
+ </div>
+ </div>
+
+
+ <!-- JavaScript placed at the end of the document so the pages load faster. -->
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+
+ <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
+ <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
+ <script>
+ $(function() {
+ $(".clickable-row").click(function() {
+ window.document.location = $(this).data("href");
+ });
+
+ $('[data-toggle="tooltip"]').tooltip()
+ });
+ </script>
+
+</body>
+</html>