You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2018/05/27 01:57:17 UTC
[24/39] atlas-website git commit: ATLAS-2691: update Apache Atlas
website for 1.0.0 release (rc0)
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/resource_EntityResource.html
----------------------------------------------------------------------
diff --git a/1.0.0-rc0/api/v2/resource_EntityResource.html b/1.0.0-rc0/api/v2/resource_EntityResource.html
new file mode 100644
index 0000000..8bb8413
--- /dev/null
+++ b/1.0.0-rc0/api/v2/resource_EntityResource.html
@@ -0,0 +1,1079 @@
+<!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>Apache Atlas Web Application: EntityResource</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">Apache Atlas Web Application: EntityResource</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>
+ <li><a href="downloads.html">Files and Libraries</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_EntityResource_deleteEntities_DELETE"><abbr title="DELETE /entities"><span class="sideoverflow">DELETE /entities</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getEntity_GET"><abbr title="GET /entities"><span class="sideoverflow">GET /entities</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_submit_POST"><abbr title="POST /entities"><span class="sideoverflow">POST /entities</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_updateEntities_PUT"><abbr title="PUT /entities"><span class="sideoverflow">PUT /entities</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_updateByUniqueAttribute_POST"><abbr title="POST /entities/qualifiedName"><span class="sideoverflow">POST /entities/qualifiedName</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getEntityDefinition_GET"><abbr title="GET /entities/{guid}"><span class="sideoverflow">GET /entities/{guid}</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_updateEntityByGuid_POST"><abbr title="POST /entities/{guid}"><span class="sideoverflow">POST /entities/{guid}</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getAuditEvents_GET"><abbr title="GET /entities/{guid}/audit"><span class="sideoverflow">GET /entities/{guid}/audit</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getTraitDefinitionsForEntity_GET"><abbr title="GET /entities/{guid}/traitDefinitions"><span class="sideoverflow">GET /entities/{guid}/traitDefinitions</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getTraitNames_GET"><abbr title="GET /entities/{guid}/traits"><span class="sideoverflow">GET /entities/{guid}/traits</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_addTrait_POST"><abbr title="POST /entities/{guid}/traits"><span class="sideoverflow">POST /entities/{guid}/traits</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_getTraitDefinitionForEntity_GET"><abbr title="GET /entities/{guid}/traitDefinitions/{traitName}"><span class="sideoverflow">GET /entities/{guid}/traitDefinitions/{traitName}</span></abbr></a></li>
+ <li><a href="#resource_EntityResource_deleteTrait_DELETE"><abbr title="DELETE /entities/{guid}/traits/{traitName}"><span class="sideoverflow">DELETE /entities/{guid}/traits/{traitName}</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_EntityResource.html">EntityResource</a></li>
+ </ol>
+
+ <h1 class="page-header">EntityResource <small>Resource</small></h1>
+
+ <p>Entity management operations as REST API.
+
+An entity is an "instance" of a Type. Entities conform to the definition
+of the Type they correspond with.</p>
+
+ <div id="resource_EntityResource_deleteEntities_DELETE">
+ <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/entities <a href="../entities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Delete entities from the repository identified by their guids (including their composite references)
+or
+Deletes a single entity identified by its type and unique attribute value from the repository (including their composite references)</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">list of deletion candidate guids
+or</span></td>
+ <td><span class="parameter-multivalued">yes</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">property</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the unique attribute used to identify the entity</span></td>
+ <td><span class="parameter-multivalued">no</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">type</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the entity type</span></td>
+ <td><span class="parameter-multivalued">no</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">value</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the unique attribute value used to identify the entity</span></td>
+ <td><span class="parameter-multivalued">no</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">response payload as json - including guids of entities(including composite references from that entity) that were deleted</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 /entities
+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_EntityResource_getEntity_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities <a href="../entities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <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">property</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">type</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">value</span></td>
+ <td>query</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 /entities
+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_EntityResource_submit_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/entities <a href="../entities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Submits the entity definitions (instances).
+The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any
+unique attribute for the give type.</p>
+
+ <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 /entities
+Accept: application/json;charset=UTF-8
+
+ </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_EntityResource_updateEntities_PUT">
+ <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/entities <a href="../entities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Complete update of a set of entities - the values not specified will be replaced with null/removed
+Adds/Updates given entities identified by its GUID or unique attribute</p>
+
+ <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">response payload as json</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 /entities
+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_EntityResource_updateByUniqueAttribute_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/entities/qualifiedName <a href="../entities/qualifiedName" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value)
+Updates support only partial update of an entity - Adds/updates any new values specified
+Updates do not support removal of attribute values</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">property</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the unique attribute used to identify the entity</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">type</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the entity type</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">value</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">the unique attributes value</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">response payload as json
+The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any
+unique attribute for the give type.</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 /entities/qualifiedName
+Accept: application/json;charset=UTF-8
+
+ </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_EntityResource_getEntityDefinition_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities/{guid} <a href="../entities/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Fetch the 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"></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 /entities/{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_EntityResource_updateEntityByGuid_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/entities/{guid} <a href="../entities/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Updates entity identified by its GUID
+Support Partial update of an entity - Adds/updates any new values specified
+Does not support removal of attribute values</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">property</span></td>
+ <td>query</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>
+POST /entities/{guid}
+Accept: application/json;charset=UTF-8
+
+ </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_EntityResource_getAuditEvents_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities/{guid}/audit <a href="../entities/{guid}/audit" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Returns the entity audit events for a given entity id. The events are returned in the decreasing order of timestamp.</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">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">count</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">number of events required</span></td>
+ <td><span class="parameter-default-value">100</span></td>
+ <td><span class="parameter-constraints">short</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">startKey</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">used for pagination. Startkey is inclusive, the returned results contain the event with the given startkey.
+First time getAuditEvents() is called for an entity, startKey should be null,
+with count = (number of events required + 1). Next time getAuditEvents() is called for the same entity,
+startKey should be equal to the entityKey of the last event returned in the previous call.</span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </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 /entities/{guid}/audit
+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_EntityResource_getTraitDefinitionsForEntity_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities/{guid}/traitDefinitions <a href="../entities/{guid}/traitDefinitions" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Fetches the trait definitions of all the traits associated to the given entity</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"></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 /entities/{guid}/traitDefinitions
+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_EntityResource_getTraitNames_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities/{guid}/traits <a href="../entities/{guid}/traits" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Gets the list of trait names 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 trait names 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 /entities/{guid}/traits
+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_EntityResource_addTrait_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/entities/{guid}/traits <a href="../entities/{guid}/traits" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Adds a new trait 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-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 /entities/{guid}/traits
+Accept: application/json;charset=UTF-8
+
+ </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_EntityResource_getTraitDefinitionForEntity_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/entities/{guid}/traitDefinitions/{traitName} <a href="../entities/{guid}/traitDefinitions/{traitName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Fetches the trait definition for an entity given its guid and trait 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">guid</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">globally unique identifier for the entity</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">traitName</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">name of the trait</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 /entities/{guid}/traitDefinitions/{traitName}
+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_EntityResource_deleteTrait_DELETE">
+ <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/entities/{guid}/traits/{traitName} <a href="../entities/{guid}/traits/{traitName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <div class="alert alert-danger">This method has been deprecated. </div>
+
+ <p>Deletes a given trait 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">guid</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">globally unique identifier for the entity</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">traitName</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">name of the trait</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 /entities/{guid}/traits/{traitName}
+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>
+
+ <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>