http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/data.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/data.html b/1.1.0/api/v2/apidocs/data.html new file mode 100644 index 0000000..b748e88 --- /dev/null +++ b/1.1.0/api/v2/apidocs/data.html @@ -0,0 +1,216 @@ +<!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: Data Types</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: Data Types</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="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</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="dropdown"><a href="data.html">Data Types</a></li> + </ol> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json">JSON</h3> + + <table class="table table-hover data-types"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PList.html"> + <td> <span class="datatype-name">PList</span> +</td> + <td> <span class="datatype-description">Paginated-list, for returning search results.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SearchFilter.html"> + <td> <span class="datatype-name">SearchFilter</span> +</td> + <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SortType.html"> + <td> <span class="datatype-name">SortType</span> +</td> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml">XML</h3> + + <table class="table table-hover data-types"> + <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="xml_ns0_PList.html"> + <td> <span class="datatype-name">PList</span> +</td> + <td> <span class="datatype-description">Paginated-list, for returning search results.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_searchFilter.html"> + <td> <span class="datatype-name">searchFilter</span> +</td> + <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_sortType.html"> + <td> <span class="datatype-name">sortType</span> +</td> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_timeBoundary.html"> + <td> <span class="datatype-name">timeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> + <td> <span class="datatype-name">atlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_status.html"> + <td> <span class="datatype-name">status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> + <td> <span class="datatype-name">atlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + </tbody> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/index.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/index.html b/1.1.0/api/v2/apidocs/index.html new file mode 100644 index 0000000..f1e1665 --- /dev/null +++ b/1.1.0/api/v2/apidocs/index.html @@ -0,0 +1,410 @@ +<!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</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</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="#resources"><abbr title="Resources"><span class="sideoverflow">Resources</span></abbr></a></li> + <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</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="dropdown"><a href="index.html">Home</a></li> + </ol> + + <div class="page-header"> + Atlas exposes a variety of REST endpoints to work with types, entities, lineage and data discovery. + </div> + + <h1 class="page-header" id="resources">Resources</h1> + + <p> + There is a <a href="application.wadl">WADL document</a> available that describes the resources API. + </p> + + <p> + You may also enjoy the <a href="ui/index.html">interactive interface</a> provided for this API by <a href="http://swagger.io">Swagger</a>. + </p> + <p> + <a href="ui/index.html" class="btn btn-default">Try it out!</a> + </p> + + <table class="table table-hover resources"> + <thead> + <tr> + <th align="center">name</th> + <th align="center">path</th> + <th align="center">methods</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="resource_DiscoveryREST.html"> + <td> <span class="resource-name">DiscoveryREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/attribute</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/basic</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/dsl</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/relationship</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/saved/execute/guid/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for data discovery using dsl or full text search</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_EntityREST.html"> + <td> <span class="resource-name">EntityREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/entity</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/classification</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/{guid}/audit</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/header</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST for a single entity</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_GlossaryREST.html"> + <td> <span class="resource-name">GlossaryREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/glossary</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/categories</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/detailed</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/related</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/category/{categoryGuid}/terms</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/term/{termGuid}/partial</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/terms/{termGuid}/related</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories/headers</span> +</samp></li><li><samp> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms/headers</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_LineageREST.html"> + <td> <span class="resource-name">LineageREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/lineage/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for an entity's lineage information</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_RelationshipREST.html"> + <td> <span class="resource-name">RelationshipREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/relationship</span> +</samp></li><li><samp> <span class="resource-path">/v2/relationship/guid/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for entity relationships.</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_TypesREST.html"> + <td> <span class="resource-name">TypesREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/types/typedefs</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedefs/headers</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/relationshipdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/name/{name}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for CRUD operations on type definitions</span> +</td> + </tr> + </tbody> + </table> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json"><span class="syntax-name">JSON</span></h3> + + <table class="table table-hover datatypes"> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasClassification.html"> + <td> <span class="datatype-name">AtlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasStruct.html"> + <td> <span class="datatype-name">AtlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> + <td> <span class="datatype-name">ClassificationAssociateRequest</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_PList.html"> + <td> <span class="datatype-name">PList</span> +</td> + <td> <span class="datatype-description">Paginated-list, for returning search results.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SearchFilter.html"> + <td> <span class="datatype-name">SearchFilter</span> +</td> + <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SortType.html"> + <td> <span class="datatype-name">SortType</span> +</td> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3> + + <table class="table table-hover datatypes"> + <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> + <thead> + <tr> + <th align="center">type</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="xml_ns0_PList.html"> + <td> <span class="datatype-name">PList</span> +</td> + <td> <span class="datatype-description">Paginated-list, for returning search results.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_searchFilter.html"> + <td> <span class="datatype-name">searchFilter</span> +</td> + <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_sortType.html"> + <td> <span class="datatype-name">sortType</span> +</td> + <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_timeBoundary.html"> + <td> <span class="datatype-name">timeBoundary</span> +</td> + <td> <span class="datatype-description">Captures time-boundary details</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> + <td> <span class="datatype-name">atlasClassification</span> +</td> + <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_status.html"> + <td> <span class="datatype-name">status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> + <td> <span class="datatype-name">atlasStruct</span> +</td> + <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> +</td> + </tr> + </tbody> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/json_AtlasClassification.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_AtlasClassification.html b/1.1.0/api/v2/apidocs/json_AtlasClassification.html new file mode 100644 index 0000000..7c55319 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_AtlasClassification.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: AtlasClassification</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: AtlasClassification</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_AtlasClassification.html">AtlasClassification</a></li> + </ol> + + <h1 class="page-header">AtlasClassification <small>Data Type</small></h1> + + <p>An instance of a classification; it doesn't have an identity, this object exists only when associated with an 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">entityGuid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">propagate</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">validityPeriods</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_TimeBoundary.html">TimeBoundary</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">entityStatus</span> +</td> + <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">removePropagationsOnEntityDelete</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + <tr> + <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasStruct.html">AtlasStruct</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">typeName</span></td> + <td><span class="datatype-reference">string +</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">{ + "entityGuid" : "...", + "propagate" : true, + "validityPeriods" : [ { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + }, { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + } ], + "entityStatus" : "ACTIVE", + "removePropagationsOnEntityDelete" : true, + "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/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/json_AtlasStruct.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_AtlasStruct.html b/1.1.0/api/v2/apidocs/json_AtlasStruct.html new file mode 100644 index 0000000..34f0ba9 --- /dev/null +++ b/1.1.0/api/v2/apidocs/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/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: 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_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/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/json_ClassificationAssociateRequest.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_ClassificationAssociateRequest.html b/1.1.0/api/v2/apidocs/json_ClassificationAssociateRequest.html new file mode 100644 index 0000000..3eb00f0 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_ClassificationAssociateRequest.html @@ -0,0 +1,159 @@ +<!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: ClassificationAssociateRequest</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: ClassificationAssociateRequest</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_ClassificationAssociateRequest.html">ClassificationAssociateRequest</a></li> + </ol> + + <h1 class="page-header">ClassificationAssociateRequest <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">classification</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasClassification.html">AtlasClassification</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">entityGuids</span> +</td> + <td> <span class="datatype-reference">array 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">{ + "classification" : { + "entityGuid" : "...", + "propagate" : true, + "validityPeriods" : [ { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + }, { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + } ], + "entityStatus" : "ACTIVE", + "removePropagationsOnEntityDelete" : true, + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "entityGuids" : [ "...", "..." ] +}</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/e7598ab3/1.1.0/api/v2/apidocs/json_PList.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_PList.html b/1.1.0/api/v2/apidocs/json_PList.html new file mode 100644 index 0000000..d9d6256 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_PList.html @@ -0,0 +1,180 @@ +<!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: PList</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: PList</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_PList.html">PList</a></li> + </ol> + + <h1 class="page-header">PList <small>Data Type</small></h1> + + <p>Paginated-list, for returning search results.</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">list</span> +</td> + <td> <span class="datatype-reference">array of object +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">pageSize</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">totalCount</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortType</span> +</td> + <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortBy</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">{ + "list" : [ { }, { } ], + "startIndex" : 12345, + "pageSize" : 12345, + "totalCount" : 12345, + "sortType" : "ASC", + "sortBy" : "..." +}</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/e7598ab3/1.1.0/api/v2/apidocs/json_SearchFilter.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_SearchFilter.html b/1.1.0/api/v2/apidocs/json_SearchFilter.html new file mode 100644 index 0000000..15a6253 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_SearchFilter.html @@ -0,0 +1,183 @@ +<!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: SearchFilter</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: SearchFilter</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_SearchFilter.html">SearchFilter</a></li> + </ol> + + <h1 class="page-header">SearchFilter <small>Data Type</small></h1> + + <p>Generic filter, to specify search criteria using name/value pairs.</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">params</span> +</td> + <td> <span class="datatype-reference">map of array of string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">maxRows</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">getCount</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortBy</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">sortType</span> +</td> + <td> <span class="datatype-reference"><a href="json_SortType.html">SortType</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "params" : { + "property1" : [ "...", "..." ], + "property2" : [ "...", "..." ] + }, + "startIndex" : 12345, + "maxRows" : 12345, + "getCount" : true, + "sortBy" : "...", + "sortType" : "ASC" +}</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/e7598ab3/1.1.0/api/v2/apidocs/json_SortType.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_SortType.html b/1.1.0/api/v2/apidocs/json_SortType.html new file mode 100644 index 0000000..84828ad --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_SortType.html @@ -0,0 +1,130 @@ +<!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: SortType</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: SortType</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="#NONE"><abbr title="NONE"><span class="sideoverflow">NONE</span></abbr></a></li> + <li><a href="#ASC"><abbr title="ASC"><span class="sideoverflow">ASC</span></abbr></a></li> + <li><a href="#DESC"><abbr title="DESC"><span class="sideoverflow">DESC</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_SortType.html">SortType</a></li> + </ol> + + <h1 class="page-header">SortType <small>Data Type</small></h1> + + <p>to specify whether the result should be sorted? If yes, whether asc or desc.</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="NONE">NONE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="ASC">ASC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="DESC">DESC</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/json_Status.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_Status.html b/1.1.0/api/v2/apidocs/json_Status.html new file mode 100644 index 0000000..e699666 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_Status.html @@ -0,0 +1,125 @@ +<!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: Status</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: Status</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="#ACTIVE"><abbr title="ACTIVE"><span class="sideoverflow">ACTIVE</span></abbr></a></li> + <li><a href="#DELETED"><abbr title="DELETED"><span class="sideoverflow">DELETED</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_Status.html">Status</a></li> + </ol> + + <h1 class="page-header">Status <small>Data Type</small></h1> + + <p>Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</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="ACTIVE">ACTIVE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value" id="DELETED">DELETED</span></td> + <td><span class="value-description"></span></td> + </tr> + </tbody> + </table> + + <footer class="footer"> + <div class="container"> + <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> + </div> + </footer> + + </div> + </div> + </div> + + + <!-- JavaScript placed at the end of the document so the pages load faster. --> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> + <script> + $(function() { + $(".clickable-row").click(function() { + window.document.location = $(this).data("href"); + }); + + $('[data-toggle="tooltip"]').tooltip() + }); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e7598ab3/1.1.0/api/v2/apidocs/json_TimeBoundary.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/json_TimeBoundary.html b/1.1.0/api/v2/apidocs/json_TimeBoundary.html new file mode 100644 index 0000000..3d9b5d5 --- /dev/null +++ b/1.1.0/api/v2/apidocs/json_TimeBoundary.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: TimeBoundary</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: TimeBoundary</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_TimeBoundary.html">TimeBoundary</a></li> + </ol> + + <h1 class="page-header">TimeBoundary <small>Data Type</small></h1> + + <p>Captures time-boundary details</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">startTime</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">endTime</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">timeZone</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">{ + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." +}</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/e7598ab3/1.1.0/api/v2/apidocs/ns0.xsd ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/apidocs/ns0.xsd b/1.1.0/api/v2/apidocs/ns0.xsd new file mode 100644 index 0000000..b6d1794 --- /dev/null +++ b/1.1.0/api/v2/apidocs/ns0.xsd @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xs:schema version="1.0" + + xmlns:xs="http://www.w3.org/2001/XMLSchema"> + + <xs:element name="PList" type="PList"/> + <xs:element name="searchFilter" type="searchFilter"/> + <xs:element name="timeBoundary" type="timeBoundary"/> + <xs:element name="atlasClassification" type="atlasClassification"/> + <xs:element name="atlasStruct" type="atlasStruct"/> +<xs:complexType name="PList"> + <xs:annotation> + <xs:documentation> + <![CDATA[Paginated-list, for returning search results.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="list" type="xs:anyType" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="startIndex" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="pageSize" type="xs:int" minOccurs="1"> + </xs:element> + <xs:element name="totalCount" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="sortType" type="sortType" minOccurs="0"> + </xs:element> + <xs:element name="sortBy" type="xs:string" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="searchFilter"> + <xs:annotation> + <xs:documentation> + <![CDATA[Generic filter, to specify search criteria using name/value pairs.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="params" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + <xs:element name="startIndex" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="maxRows" type="xs:long" minOccurs="1"> + </xs:element> + <xs:element name="getCount" type="xs:boolean" minOccurs="1"> + </xs:element> + <xs:element name="sortBy" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="sortType" type="sortType" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:simpleType name="sortType"> + <xs:annotation> + <xs:documentation> + <![CDATA[to specify whether the result should be sorted? If yes, whether asc or desc.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="NONE"/> + + <xs:enumeration value="ASC"/> + + <xs:enumeration value="DESC"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="timeBoundary"> + <xs:annotation> + <xs:documentation> + <![CDATA[Captures time-boundary details]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="startTime" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="endTime" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="timeZone" type="xs:string" minOccurs="0"> + </xs:element> + </xs:sequence> +</xs:complexType> + +<xs:complexType name="atlasClassification"> + <xs:annotation> + <xs:documentation> + <![CDATA[An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.]]> + </xs:documentation> + </xs:annotation> + <xs:complexContent> + <xs:extension base="atlasStruct"> + <xs:sequence> + <xs:element name="entityGuid" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="propagate" type="xs:boolean" minOccurs="0"> + </xs:element> + <xs:element name="validityPeriods" type="timeBoundary" minOccurs="0" maxOccurs="unbounded"> + </xs:element> + <xs:element name="entityStatus" type="status" minOccurs="0"> + </xs:element> + <xs:element name="removePropagationsOnEntityDelete" type="xs:boolean" minOccurs="0"> + </xs:element> + </xs:sequence> + </xs:extension> + </xs:complexContent> +</xs:complexType> + +<xs:simpleType name="status"> + <xs:annotation> + <xs:documentation> + <![CDATA[Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.]]> + </xs:documentation> + </xs:annotation> + <xs:restriction base="xs:string"> + + <xs:enumeration value="ACTIVE"/> + + <xs:enumeration value="DELETED"/> + </xs:restriction> +</xs:simpleType> + +<xs:complexType name="atlasStruct"> + <xs:annotation> + <xs:documentation> + <![CDATA[Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.]]> + </xs:documentation> + </xs:annotation> + <xs:sequence> + <xs:element name="typeName" type="xs:string" minOccurs="0"> + </xs:element> + <xs:element name="attributes" minOccurs="0"> + <xs:complexType> + <xs:sequence> + <xs:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xs:complexType> + <xs:sequence> + <xs:element name="key" minOccurs="1" type="xs:string"/> + <xs:element name="value" minOccurs="1" type="xs:anyType"/> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> + </xs:complexType> + </xs:element> + </xs:sequence> +</xs:complexType> + +</xs:schema> \ No newline at end of file