http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c3e5130b/api/v2/v2/apidocs/resource_EntityREST.html ---------------------------------------------------------------------- diff --git a/api/v2/v2/apidocs/resource_EntityREST.html b/api/v2/v2/apidocs/resource_EntityREST.html new file mode 100644 index 0000000..c8ba3db --- /dev/null +++ b/api/v2/v2/apidocs/resource_EntityREST.html @@ -0,0 +1,1263 @@ +<!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: EntityREST</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: EntityREST</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_EntityREST_createOrUpdate_POST"><abbr title="POST /v2/entity"><span class="sideoverflow">POST /v2/entity</span></abbr></a></li> + <li><a href="#resource_EntityREST_deleteByGuids_DELETE"><abbr title="DELETE /v2/entity/bulk"><span class="sideoverflow">DELETE /v2/entity/bulk</span></abbr></a></li> + <li><a href="#resource_EntityREST_getByGuids_GET"><abbr title="GET /v2/entity/bulk"><span class="sideoverflow">GET /v2/entity/bulk</span></abbr></a></li> + <li><a href="#resource_EntityREST_createOrUpdate_POST"><abbr title="POST /v2/entity/bulk"><span class="sideoverflow">POST /v2/entity/bulk</span></abbr></a></li> + <li><a href="#resource_EntityREST_addClassification_POST"><abbr title="POST /v2/entity/bulk/classification"><span class="sideoverflow">POST /v2/entity/bulk/classification</span></abbr></a></li> + <li><a href="#resource_EntityREST_deleteByGuid_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_EntityREST_getById_GET"><abbr title="GET /v2/entity/guid/{guid}"><span class="sideoverflow">GET /v2/entity/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT"><abbr title="PUT /v2/entity/guid/{guid}"><span class="sideoverflow">PUT /v2/entity/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_EntityREST_getClassifications_GET"><abbr title="GET /v2/entity/guid/{guid}/classifications"><span class="sideoverflow">GET /v2/entity/guid/{guid}/classifications</span></abbr></a></li> + <li><a href="#resource_EntityREST_addClassifications_POST"><abbr title="POST /v2/entity/guid/{guid}/classifications"><span class="sideoverflow">POST /v2/entity/guid/{guid}/classifications</span></abbr></a></li> + <li><a href="#resource_EntityREST_updateClassification_PUT"><abbr title="PUT /v2/entity/guid/{guid}/classifications"><span class="sideoverflow">PUT /v2/entity/guid/{guid}/classifications</span></abbr></a></li> + <li><a href="#resource_EntityREST_deleteByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}"><span class="sideoverflow">DELETE /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> + <li><a href="#resource_EntityREST_getByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}"><span class="sideoverflow">GET /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> + <li><a href="#resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}"><span class="sideoverflow">PUT /v2/entity/uniqueAttribute/type/{typeName}</span></abbr></a></li> + <li><a href="#resource_EntityREST_deleteClassification_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/classification/{classificationName}"><span class="sideoverflow">DELETE /v2/entity/guid/{guid}/classification/{classificationName}</span></abbr></a></li> + <li><a href="#resource_EntityREST_getClassification_GET"><abbr title="GET /v2/entity/guid/{guid}/classification/{classificationName}"><span class="sideoverflow">GET /v2/entity/guid/{guid}/classification/{classificationName}</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_EntityREST.html">EntityREST</a></li> + </ol> + + <h1 class="page-header">EntityREST <small>Resource</small></h1> + + <p>REST for a single entity</p> + + <div id="resource_EntityREST_createOrUpdate_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity <a href="../v2/entity" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Create new entity or update existing entity in Atlas. +Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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">EntityMutationResponse</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/entity +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 201 Created +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_deleteByGuids_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk API to delete list of entities identified by its GUIDs</p> + + <table class="table resource-parameters"> + <caption>Request Parameters</caption> + <thead> + <tr> + <th>name</th> + <th>type</th> + <th>description</th> + <th>multivalued</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">guid</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-multivalued">yes</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"></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/entity/bulk +Accept: application/json;charset=UTF-8 + + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_getByGuids_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk API to retrieve list of entities identified by its GUIDs.</p> + + <table class="table resource-parameters"> + <caption>Request Parameters</caption> + <thead> + <tr> + <th>name</th> + <th>type</th> + <th>description</th> + <th>multivalued</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">guid</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-multivalued">yes</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"></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/entity/bulk +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_EntityREST_createOrUpdate_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/bulk <a href="../v2/entity/bulk" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk API to create new entities or update existing entities in Atlas. +Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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"></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/entity/bulk +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 201 Created +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_addClassification_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/bulk/classification <a href="../v2/entity/bulk/classification" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Bulk API to associate a tag to multiple entities</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference"><a href="json_ClassificationAssociateRequest.html">ClassificationAssociateRequest</a> + (JSON)</span></td> + </tr> + <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> + </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/entity/bulk/classification +Content-Type: application/json + + <code class="prettyprint language-js"> +{ + "classification" : { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "entityGuids" : [ "...", "..." ] +} + </code> + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 201 Created + + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_deleteByGuid_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Delete an entity identified by its 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">GUID for the entity</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">EntityMutationResponse</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/entity/guid/{guid} +Accept: application/json;charset=UTF-8 + + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_getById_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Fetch complete definition of an entity given its 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">GUID for the entity</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">AtlasEntity</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/entity/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_EntityREST_partialUpdateEntityAttrByGuid_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid} <a href="../v2/entity/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Entity Partial Update - Add/Update entity attribute identified by its GUID. +Supports only uprimitive attribute type and entity references. +does not support updation of complex types like arrays, maps +Null updates are not possible</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"></span></td> + </tr> + <tr> + <td><span class="parameter-name">name</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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"></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/entity/guid/{guid} +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 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_getClassifications_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Gets the list of classifications for a given entity represented by a 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">globally unique identifier for the entity</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 list of classifications for the given entity guid</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/entity/guid/{guid}/classifications +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_EntityREST_addClassifications_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Adds classifications to an existing entity represented by a 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">globally unique identifier for the entity</span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> + (JSON)</span></td> + </tr> + <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> + </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/entity/guid/{guid}/classifications +Content-Type: application/json + + <code class="prettyprint language-js"> +[ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} ] + </code> + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 201 Created + + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_updateClassification_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/guid/{guid}/classifications <a href="../v2/entity/guid/{guid}/classifications" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Updates classifications to an existing entity represented by a 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">globally unique identifier for the entity</span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> + (JSON)</span></td> + </tr> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> + <td><span class="datatype-reference">list of <a href="xml_ns0_atlasClassification.html">atlasClassification</a> + (XML)</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/entity/guid/{guid}/classifications +Content-Type: application/json + + <code class="prettyprint language-js"> +[ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +} ] + </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_EntityREST_deleteByUniqueAttribute_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Delete an entity identified by its type and unique attributes.</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">typeName</span></td> + <td>path</td> + <td><span class="parameter-description">- entity type to be deleted</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">EntityMutationResponse</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/entity/uniqueAttribute/type/{typeName} +Accept: application/json;charset=UTF-8 + + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_getByUniqueAttributes_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Fetch complete definition of an entity given its type and unique attribute.</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">typeName</span></td> + <td>path</td> + <td><span class="parameter-description"></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">AtlasEntityWithExtInfo</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/entity/uniqueAttribute/type/{typeName} +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_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName} <a href="../v2/entity/uniqueAttribute/type/{typeName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Entity Partial Update - Allows a subset of attributes to be updated on +an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. +Null updates are not possible</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">typeName</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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"></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/entity/uniqueAttribute/type/{typeName} +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 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_EntityREST_deleteClassification_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName} <a href="../v2/entity/guid/{guid}/classification/{classificationName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Deletes a given classification from an existing entity represented by a 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">classificationName</span></td> + <td>path</td> + <td><span class="parameter-description">name of the classifcation</span></td> + </tr> + <tr> + <td><span class="parameter-name">guid</span></td> + <td>path</td> + <td><span class="parameter-description">globally unique identifier for the entity</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/entity/guid/{guid}/classification/{classificationName} + + </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_EntityREST_getClassification_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName} <a href="../v2/entity/guid/{guid}/classification/{classificationName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Gets the list of classifications for a given entity represented by a 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">classificationName</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + </tr> + <tr> + <td><span class="parameter-name">guid</span></td> + <td>path</td> + <td><span class="parameter-description">globally unique identifier for the entity</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 for the given entity guid</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/entity/guid/{guid}/classification/{classificationName} +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/c3e5130b/api/v2/v2/apidocs/resource_LineageREST.html ---------------------------------------------------------------------- diff --git a/api/v2/v2/apidocs/resource_LineageREST.html b/api/v2/v2/apidocs/resource_LineageREST.html new file mode 100644 index 0000000..2f46369 --- /dev/null +++ b/api/v2/v2/apidocs/resource_LineageREST.html @@ -0,0 +1,211 @@ +<!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: LineageREST</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: LineageREST</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_LineageREST_getLineageGraph_GET"><abbr title="GET /v2/lineage/{guid}"><span class="sideoverflow">GET /v2/lineage/{guid}</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_LineageREST.html">LineageREST</a></li> + </ol> + + <h1 class="page-header">LineageREST <small>Resource</small></h1> + + <p>REST interface for an entity's lineage information</p> + + <div id="resource_LineageREST_getLineageGraph_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/lineage/{guid} <a href="../v2/lineage/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Returns lineage info about entity.</p> + + <table class="table resource-parameters"> + <caption>Request Parameters</caption> + <thead> + <tr> + <th>name</th> + <th>type</th> + <th>description</th> + <th>default</th> + <th>constraints</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">guid</span></td> + <td>path</td> + <td><span class="parameter-description">- unique entity id</span></td> + <td><span class="parameter-default-value"> </span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + <tr> + <td><span class="parameter-name">depth</span></td> + <td>query</td> + <td><span class="parameter-description">- number of hops for lineage</span></td> + <td><span class="parameter-default-value">3</span></td> + <td><span class="parameter-constraints">int</span></td> + </tr> + <tr> + <td><span class="parameter-name">direction</span></td> + <td>query</td> + <td><span class="parameter-description">- input, output or both</span></td> + <td><span class="parameter-default-value">BOTH</span></td> + <td><span class="parameter-constraints">"BOTH" or "INPUT" or "OUTPUT"</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">If Lineage exists for the given entity</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">400</span></td> + <td><span class="response-condition">Bad query parameters</span></td> + </tr> + <tr> + <td><span class="label label-warning response-code">404</span></td> + <td><span class="response-condition">If no lineage is found for the given entity</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">AtlasLineageInfo</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/lineage/{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> + + <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/c3e5130b/api/v2/v2/apidocs/resource_RelationshipREST.html ---------------------------------------------------------------------- diff --git a/api/v2/v2/apidocs/resource_RelationshipREST.html b/api/v2/v2/apidocs/resource_RelationshipREST.html new file mode 100644 index 0000000..ac9837a --- /dev/null +++ b/api/v2/v2/apidocs/resource_RelationshipREST.html @@ -0,0 +1,358 @@ +<!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: RelationshipREST</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: RelationshipREST</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_RelationshipREST_create_POST"><abbr title="POST /v2/relationship"><span class="sideoverflow">POST /v2/relationship</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_update_PUT"><abbr title="PUT /v2/relationship"><span class="sideoverflow">PUT /v2/relationship</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_deleteById_DELETE"><abbr title="DELETE /v2/relationship/guid/{guid}"><span class="sideoverflow">DELETE /v2/relationship/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_getById_GET"><abbr title="GET /v2/relationship/guid/{guid}"><span class="sideoverflow">GET /v2/relationship/guid/{guid}</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_RelationshipREST.html">RelationshipREST</a></li> + </ol> + + <h1 class="page-header">RelationshipREST <small>Resource</small></h1> + + <p>REST interface for entity relationships.</p> + + <div id="resource_RelationshipREST_create_POST"> + <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Create a new relationship between entities.</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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"></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/relationship +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 201 Created +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RelationshipREST_update_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/relationship <a href="../v2/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Update an existing relationship between entities.</p> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</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> + </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"></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/relationship +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 204 No Content +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RelationshipREST_deleteById_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Delete a relationship between entities using 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"></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/relationship/guid/{guid} + + </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_RelationshipREST_getById_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/relationship/guid/{guid} <a href="../v2/relationship/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + + <p>Get relationship information between entities using 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"></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"></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/relationship/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> + + <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>
