http://git-wip-us.apache.org/repos/asf/atlas-website/blob/2f6afcd8/0.8.3/api/v2/resources.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/resources.html b/0.8.3/api/v2/resources.html new file mode 100644 index 0000000..63dfc84 --- /dev/null +++ b/0.8.3/api/v2/resources.html @@ -0,0 +1,218 @@ +<!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: Resources</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: Resources</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="dropdown"><a href="resources.html">Resources</a></li> + </ol> + + <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/{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> <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_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_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/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><li><samp> <span class="resource-path">/v2/types/typedef/name/{typeName}</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">DELETE</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for CRUD operations on type definitions</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/2f6afcd8/0.8.3/api/v2/syntax_json.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/syntax_json.html b/0.8.3/api/v2/syntax_json.html new file mode 100644 index 0000000..b925382 --- /dev/null +++ b/0.8.3/api/v2/syntax_json.html @@ -0,0 +1,391 @@ +<!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: JSON</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: JSON</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="dropdown"><a href="syntax_json.html">JSON</a></li> + </ol> + + <h1 class="page-header">JSON</h1> + + <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_AtlasAttributeDef.html"> + <td> <span class="datatype-name">AtlasAttributeDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a struct-attribute.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasBaseModelObject.html"> + <td> <span class="datatype-name">AtlasBaseModelObject</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html"> + <td> <span class="datatype-name">AtlasBaseTypeDef</span> +</td> + <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span> +</td> + </tr> + <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_AtlasClassificationDef.html"> + <td> <span class="datatype-name">AtlasClassificationDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a classification-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasClassifications.html"> + <td> <span class="datatype-name">AtlasClassifications</span> +</td> + <td> <span class="datatype-description">REST serialization friendly list.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasConstraintDef.html"> + <td> <span class="datatype-name">AtlasConstraintDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a constraint.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html"> + <td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityDef.html"> + <td> <span class="datatype-name">AtlasEntityDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a entity-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html"> + <td> <span class="datatype-name">AtlasEntityExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html"> + <td> <span class="datatype-name">AtlasEntityWithExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEnumDef.html"> + <td> <span class="datatype-name">AtlasEnumDef</span> +</td> + <td> <span class="datatype-description">class that captures details of an enum-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEnumElementDef.html"> + <td> <span class="datatype-name">AtlasEnumElementDef</span> +</td> + <td> <span class="datatype-description">class that captures details of an enum-element.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasFullTextResult.html"> + <td> <span class="datatype-name">AtlasFullTextResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasLineageInfo.html"> + <td> <span class="datatype-name">AtlasLineageInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasQueryType.html"> + <td> <span class="datatype-name">AtlasQueryType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasSearchResult.html"> + <td> <span class="datatype-name">AtlasSearchResult</span> +</td> + <td> <span class="datatype-description"></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_AtlasStructDef.html"> + <td> <span class="datatype-name">AtlasStructDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a struct-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html"> + <td> <span class="datatype-name">AtlasTypeDefHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTypesDef.html"> + <td> <span class="datatype-name">AtlasTypesDef</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasUserSavedSearch.html"> + <td> <span class="datatype-name">AtlasUserSavedSearch</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AttributeSearchResult.html"> + <td> <span class="datatype-name">AttributeSearchResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Cardinality.html"> + <td> <span class="datatype-name">Cardinality</span> +</td> + <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</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_Condition.html"> + <td> <span class="datatype-name">Condition</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Currency.html"> + <td> <span class="datatype-name">Currency</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_DateFormat.html"> + <td> <span class="datatype-name">DateFormat</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityMutationResponse.html"> + <td> <span class="datatype-name">EntityMutationResponse</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityOperation.html"> + <td> <span class="datatype-name">EntityOperation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_FilterCriteria.html"> + <td> <span class="datatype-name">FilterCriteria</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Format.html"> + <td> <span class="datatype-name">Format</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_LineageDirection.html"> + <td> <span class="datatype-name">LineageDirection</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_LineageRelation.html"> + <td> <span class="datatype-name">LineageRelation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Locale.html"> + <td> <span class="datatype-name">Locale</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_NumberFormat.html"> + <td> <span class="datatype-name">NumberFormat</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Operator.html"> + <td> <span class="datatype-name">Operator</span> +</td> + <td> <span class="datatype-description">Supported search operations +Logical comparision operators can only be used with numbers or dates +IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</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_RoundingMode.html"> + <td> <span class="datatype-name">RoundingMode</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SavedSearchType.html"> + <td> <span class="datatype-name">SavedSearchType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SearchParameters.html"> + <td> <span class="datatype-name">SearchParameters</span> +</td> + <td> <span class="datatype-description"></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_TimeZone.html"> + <td> <span class="datatype-name">TimeZone</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TypeCategory.html"> + <td> <span class="datatype-name">TypeCategory</span> +</td> + <td> <span class="datatype-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/2f6afcd8/0.8.3/api/v2/syntax_xml.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/syntax_xml.html b/0.8.3/api/v2/syntax_xml.html new file mode 100644 index 0000000..8bd8624 --- /dev/null +++ b/0.8.3/api/v2/syntax_xml.html @@ -0,0 +1,144 @@ +<!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: XML</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: XML</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="dropdown"><a href="syntax_xml.html">XML</a></li> + </ol> + + <h1 class="page-header">XML</h1> + + <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_atlasBaseModelObject.html"> + <td> <span class="datatype-name">atlasBaseModelObject</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <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_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_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/2f6afcd8/0.8.3/api/v2/xml_ns0_PList.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_PList.html b/0.8.3/api/v2/xml_ns0_PList.html new file mode 100644 index 0000000..0819f11 --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_PList.html @@ -0,0 +1,242 @@ +<!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/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: 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_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_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"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">list</span> +</td> + <td> <span class="datatype-reference">anyType +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/unbounded +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">pageSize</span> +</td> + <td> <span class="datatype-reference">int +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</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-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</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="xml_ns0_sortType.html">sortType</a> +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">totalCount</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><PList> + <list>...</list> + <startIndex>...</startIndex> + <pageSize>...</pageSize> + <totalCount>...</totalCount> + <sortType>...</sortType> + <sortBy>...</sortBy> +</PList> +</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/2f6afcd8/0.8.3/api/v2/xml_ns0_atlasBaseModelObject.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_atlasBaseModelObject.html b/0.8.3/api/v2/xml_ns0_atlasBaseModelObject.html new file mode 100644 index 0000000..5e74dbf --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_atlasBaseModelObject.html @@ -0,0 +1,151 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + + <title>Atlas REST API: atlasBaseModelObject</title> + + <!-- Mobile viewport optimized: j.mp/bplateviewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Bootstrap core CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> + + <!--custom css for these pages--> + <link rel="stylesheet" href="css/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: atlasBaseModelObject</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="resources.html">Resources</a></li> + <li><a href="data.html">Data Types</a></li> + </ul> + </div> + </div> + </nav> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-3 col-md-2 sidebar" id="apinav"> + <ul class="nav nav-sidebar"> + <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> + </ul> + </div> + + <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> + <ol class="breadcrumb" id="top"> + <li class="active dropdown"><a href="index.html">Home</a></li> + <li class="active dropdown"><a href="syntax_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_atlasBaseModelObject.html">atlasBaseModelObject</a></li> + </ol> + + <h1 class="page-header">atlasBaseModelObject <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + <dt>Abstract Type</dt> + <dd></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</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-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div> + + <pre class="prettyprint language-xml example"><atlasBaseModelObject> + <guid>...</guid> +</atlasBaseModelObject> +</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/2f6afcd8/0.8.3/api/v2/xml_ns0_atlasClassification.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_atlasClassification.html b/0.8.3/api/v2/xml_ns0_atlasClassification.html new file mode 100644 index 0000000..6456c5e --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_atlasClassification.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: 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/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: 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_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_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"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + </tbody> + <tr> + <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_atlasStruct.html">atlasStruct</a></h5></td> + </tr> + <tbody> + <tr> + <td><span class="property-name">attributes</span></td> + <td><span class="datatype-reference">(custom) +</span></td> + <td><span class="property-type">element +</span></td> + <td><span class="property-namespaceInfo"> +</span></td> + <td><span class="property-minMaxOccurs">0/1 +</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-type">element +</span></td> + <td><span class="property-namespaceInfo"> +</span></td> + <td><span class="property-minMaxOccurs">0/1 +</span></td> + <td><span class="property-description"> </span></td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><atlasClassification> + <typeName>...</typeName> + <attributes>...</attributes> +</atlasClassification> +</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/2f6afcd8/0.8.3/api/v2/xml_ns0_atlasStruct.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_atlasStruct.html b/0.8.3/api/v2/xml_ns0_atlasStruct.html new file mode 100644 index 0000000..f25e92b --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_atlasStruct.html @@ -0,0 +1,168 @@ +<!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_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_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>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + <dt>Subtypes</dt> + <dd><a href="xml_ns0_atlasClassification.html">atlasClassification</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">attributes</span> +</td> + <td> <span class="datatype-reference">(custom) +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</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-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><atlasStruct> + <typeName>...</typeName> + <attributes>...</attributes> +</atlasStruct> +</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/2f6afcd8/0.8.3/api/v2/xml_ns0_searchFilter.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_searchFilter.html b/0.8.3/api/v2/xml_ns0_searchFilter.html new file mode 100644 index 0000000..fbe654c --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_searchFilter.html @@ -0,0 +1,242 @@ +<!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/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: 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_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_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"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>type</th> + <th>namespace</th> + <th>min/max occurs</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">getCount</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">maxRows</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">params</span> +</td> + <td> <span class="datatype-reference">(custom) +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</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-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</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="xml_ns0_sortType.html">sortType</a> +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">0/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + <tr> + <td> <span class="property-name">startIndex</span> +</td> + <td> <span class="datatype-reference">long +</span> +</td> + <td> <span class="property-type">element +</span> +</td> + <td> <span class="property-namespaceInfo"> +</span> +</td> + <td> <span class="property-minMaxOccurs">1/1 +</span> +</td> + <td> <span class="property-description"> </span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-xml example"><searchFilter> + <params>...</params> + <startIndex>...</startIndex> + <maxRows>...</maxRows> + <getCount>...</getCount> + <sortBy>...</sortBy> + <sortType>...</sortType> +</searchFilter> +</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/2f6afcd8/0.8.3/api/v2/xml_ns0_sortType.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/xml_ns0_sortType.html b/0.8.3/api/v2/xml_ns0_sortType.html new file mode 100644 index 0000000..8d42fbb --- /dev/null +++ b/0.8.3/api/v2/xml_ns0_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/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: 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 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_xml.html">XML</a></li> + <li class="dropdown"><a href="xml_ns0_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"> + <dt>Namespace</dt> + <dd>(Default)</dd> + <dt>Schema</dt> + <dd><a href="ns0.xsd">ns0.xsd</a></dd> + </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">NONE</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">ASC</span></td> + <td><span class="value-description"></span></td> + </tr> + <tr> + <td><span class="value-value">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>