http://git-wip-us.apache.org/repos/asf/atlas-website/blob/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/resource_TypesREST.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/resource_TypesREST.html b/1.0.0-alpha/api/v2/v2/apidocs/resource_TypesREST.html deleted file mode 100644 index fe3b1ba..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/resource_TypesREST.html +++ /dev/null @@ -1,1563 +0,0 @@ -<!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: TypesREST</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: TypesREST</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="#resource_TypesREST_deleteAtlasTypeDefs_DELETE"><abbr title="DELETE /v2/types/typedefs"><span class="sideoverflow">DELETE /v2/types/typedefs</span></abbr></a></li> - <li><a href="#resource_TypesREST_getAllTypeDefs_GET"><abbr title="GET /v2/types/typedefs"><span class="sideoverflow">GET /v2/types/typedefs</span></abbr></a></li> - <li><a href="#resource_TypesREST_createAtlasTypeDefs_POST"><abbr title="POST /v2/types/typedefs"><span class="sideoverflow">POST /v2/types/typedefs</span></abbr></a></li> - <li><a href="#resource_TypesREST_updateAtlasTypeDefs_PUT"><abbr title="PUT /v2/types/typedefs"><span class="sideoverflow">PUT /v2/types/typedefs</span></abbr></a></li> - <li><a href="#resource_TypesREST_getTypeDefHeaders_GET"><abbr title="GET /v2/types/typedefs/headers"><span class="sideoverflow">GET /v2/types/typedefs/headers</span></abbr></a></li> - <li><a href="#resource_TypesREST_getClassificationDefByGuid_GET"><abbr title="GET /v2/types/classificationdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/classificationdef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getClassificationDefByName_GET"><abbr title="GET /v2/types/classificationdef/name/{name}"><span class="sideoverflow">GET /v2/types/classificationdef/name/{name}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getEntityDefByGuid_GET"><abbr title="GET /v2/types/entitydef/guid/{guid}"><span class="sideoverflow">GET /v2/types/entitydef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getEntityDefByName_GET"><abbr title="GET /v2/types/entitydef/name/{name}"><span class="sideoverflow">GET /v2/types/entitydef/name/{name}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getEnumDefByGuid_GET"><abbr title="GET /v2/types/enumdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/enumdef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getEnumDefByName_GET"><abbr title="GET /v2/types/enumdef/name/{name}"><span class="sideoverflow">GET /v2/types/enumdef/name/{name}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getRelationshipDefByGuid_GET"><abbr title="GET /v2/types/relationshipdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/relationshipdef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getRelationshipDefByName_GET"><abbr title="GET /v2/types/relationshipdef/name/{name}"><span class="sideoverflow">GET /v2/types/relationshipdef/name/{name}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getStructDefByGuid_GET"><abbr title="GET /v2/types/structdef/guid/{guid}"><span class="sideoverflow">GET /v2/types/structdef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getStructDefByName_GET"><abbr title="GET /v2/types/structdef/name/{name}"><span class="sideoverflow">GET /v2/types/structdef/name/{name}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getTypeDefByGuid_GET"><abbr title="GET /v2/types/typedef/guid/{guid}"><span class="sideoverflow">GET /v2/types/typedef/guid/{guid}</span></abbr></a></li> - <li><a href="#resource_TypesREST_getTypeDefByName_GET"><abbr title="GET /v2/types/typedef/name/{name}"><span class="sideoverflow">GET /v2/types/typedef/name/{name}</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="resources.html">Resources</a></li> - <li class="dropdown"><a href="resource_TypesREST.html">TypesREST</a></li> - </ol> - - <h1 class="page-header">TypesREST <small>Resource</small></h1> - - <p>REST interface for CRUD operations on type definitions</p> - - <div id="resource_TypesREST_deleteAtlasTypeDefs_DELETE"> - <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Bulk delete API for all types</p> - - <table class="table resource-request-body"> - <caption>Request Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="request-description">A composite object that captures all types to be deleted</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">204</span></td> - <td><span class="response-condition">On successful deletion of the requested type definitions</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">400</span></td> - <td><span class="response-condition">On validation failure for any type definitions</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -DELETE /v2/types/typedefs -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 204 No Content - - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getAllTypeDefs_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Bulk retrieval API for retrieving all type definitions in Atlas</p> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">A composite wrapper object with lists of all type definitions</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/typedefs -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_createAtlasTypeDefs_POST"> - <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Bulk create APIs for all atlas type definitions, only new definitions will be created. -Any changes to the existing definitions will be discarded</p> - - <table class="table resource-request-body"> - <caption>Request Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="request-description">A composite wrapper object with corresponding lists of the type definition</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful update of requested type definitions</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">400</span></td> - <td><span class="response-condition">On validation failure for any type definitions</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">A composite wrapper object with lists of type definitions that were successfully -created</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -POST /v2/types/typedefs -Content-Type: application/json;charset=UTF-8 -Accept: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_updateAtlasTypeDefs_PUT"> - <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/types/typedefs <a href="../v2/types/typedefs" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Bulk update API for all types, changes detected in the type definitions would be persisted</p> - - <table class="table resource-request-body"> - <caption>Request Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="request-description">A composite object that captures all type definition changes</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful update of requested type definitions</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">400</span></td> - <td><span class="response-condition">On validation failure for any type definitions</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">A composite object with lists of type definitions that were updated</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -PUT /v2/types/typedefs -Content-Type: application/json;charset=UTF-8 -Accept: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getTypeDefHeaders_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedefs/headers <a href="../v2/types/typedefs/headers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Bulk retrieval API for all type definitions returned as a list of minimal information header</p> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">Returns a list of AtlasTypeDefHeader matching the search criteria -or an empty list if no match.</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">List of AtlasTypeDefHeader AtlasTypeDefHeader</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/typedefs/headers -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getClassificationDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/classificationdef/guid/{guid} <a href="../v2/types/classificationdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the classification definition for the given guid</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">classification guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the classification definition by it's guid</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">classification definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/classificationdef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getClassificationDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/classificationdef/name/{name} <a href="../v2/types/classificationdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the classification definition by it's name (unique)</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">classification name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the classification definition by it's name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">classification definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/classificationdef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getEntityDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/guid/{guid} <a href="../v2/types/entitydef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the Entity definition for the given guid</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">entity guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the entity definition by it's guid</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">Entity definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/entitydef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getEntityDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/entitydef/name/{name} <a href="../v2/types/entitydef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the entity definition by it's name (unique)</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">entity name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the entity definition by it's name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">Entity definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/entitydef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getEnumDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/guid/{guid} <a href="../v2/types/enumdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the enum definition for the given guid</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">enum guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the enum definition by it's guid</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">enum definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/enumdef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getEnumDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/enumdef/name/{name} <a href="../v2/types/enumdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the enum definition by it's name (unique)</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">enum name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the enum definition by it's name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">enum definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/enumdef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getRelationshipDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/relationshipdef/guid/{guid} <a href="../v2/types/relationshipdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the relationship definition for the given guid</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">relationship guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the relationship definition by it's guid</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">relationship definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/relationshipdef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getRelationshipDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/relationshipdef/name/{name} <a href="../v2/types/relationshipdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the relationship definition by it's name (unique)</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">relationship name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the relationship definition by it's name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">relationship definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/relationshipdef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getStructDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/structdef/guid/{guid} <a href="../v2/types/structdef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the struct definition for the given guid</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">struct guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the struct definition by it's guid</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given guid</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">struct definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/structdef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getStructDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/structdef/name/{name} <a href="../v2/types/structdef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get the struct definition by it's name (unique)</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">struct name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">On successful lookup of the the struct definition by it's name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">On Failed lookup for the given name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">struct definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/structdef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getTypeDefByGuid_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedef/guid/{guid} <a href="../v2/types/typedef/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p></p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">guid</span></td> - <td>path</td> - <td><span class="parameter-description">GUID of the type</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">Successful lookup</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">Failed lookup</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">Type definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/typedef/guid/{guid} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_TypesREST_getTypeDefByName_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/types/typedef/name/{name} <a href="../v2/types/typedef/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> - - <p>Get type definition by it's name</p> - - <table class="table resource-parameters"> - <caption>Request Parameters</caption> - <thead> - <tr> - <th>name</th> - <th>type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description">Type name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-codes"> - <caption>Response Codes</caption> - <thead> - <tr> - <th>code</th> - <th>condition</th> - </tr> - </thead> - <tbody> - <tr> - <td><span class="label label-success response-code">200</span></td> - <td><span class="response-condition">Successful lookup by name</span></td> - </tr> - <tr> - <td><span class="label label-warning response-code">404</span></td> - <td><span class="response-condition">Failed lookup by name</span></td> - </tr> - </tbody> - </table> - - <table class="table resource-response-body"> - <caption>Response Body</caption> - <thead> - <tr> - <th>media type</th> - <th>data type</th> - <th>description</th> - </tr> - </thead> - <tbody> - <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> - <td><span class="datatype-reference">(custom) -</span></td> - <td><span class="response-description">Type definition</span></td> - </tr> - </tbody> - </table> - <h4>Example</h4> - - <div class="container-fluid example panel"> - <div class="row panel-body"> - <div class="col-md-6"> - <h5>Request</h5> - <pre> -GET /v2/types/typedef/name/{name} -Accept: application/json;charset=UTF-8 - - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - </div> - </div> - </div> - - <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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/resources.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/resources.html b/1.0.0-alpha/api/v2/v2/apidocs/resources.html deleted file mode 100644 index 810f69a..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/resources.html +++ /dev/null @@ -1,226 +0,0 @@ -<!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/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: 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/uniqueAttribute/type/{typeName}</span> -</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/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">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></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_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> - - <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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/syntax_json.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/syntax_json.html b/1.0.0-alpha/api/v2/v2/apidocs/syntax_json.html deleted file mode 100644 index be60f7a..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/syntax_json.html +++ /dev/null @@ -1,149 +0,0 @@ -<!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/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: 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_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_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> - </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/af60ed7f/1.0.0-alpha/api/v2/v2/apidocs/syntax_xml.html ---------------------------------------------------------------------- diff --git a/1.0.0-alpha/api/v2/v2/apidocs/syntax_xml.html b/1.0.0-alpha/api/v2/v2/apidocs/syntax_xml.html deleted file mode 100644 index a90bf41..0000000 --- a/1.0.0-alpha/api/v2/v2/apidocs/syntax_xml.html +++ /dev/null @@ -1,144 +0,0 @@ -<!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/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: 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>