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 2017/03/17 06:00:09 UTC
[06/38] incubator-atlas-website git commit: added documentation to
0.8-incubating release folder
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/api/v2/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_DiscoveryREST.html b/api/v2/resource_DiscoveryREST.html
index 12e9140..63e4875 100644
--- a/api/v2/resource_DiscoveryREST.html
+++ b/api/v2/resource_DiscoveryREST.html
@@ -50,6 +50,7 @@
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
+ <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET">GET /v2/search/basic</a></li>
<li><a href="#resource_DiscoveryREST_searchUsingDSL_GET">GET /v2/search/dsl</a></li>
<li><a href="#resource_DiscoveryREST_searchUsingFullText_GET">GET /v2/search/fulltext</a></li>
<li class="divider"></li>
@@ -68,6 +69,178 @@
<p>REST interface for data discovery using dsl or full text search</p>
+ <div id="resource_DiscoveryREST_searchUsingBasic_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Retrieve data for the specified fulltext query</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ <th>constraints</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">classification</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">limit</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">offset</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">query</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">Fulltext query</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">typeName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-codes">
+ <caption>Response Codes</caption>
+ <thead>
+ <tr>
+ <th>code</th>
+ <th>condition</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="label label-success response-code">200</span></td>
+ <td><span class="response-condition">On successful FullText lookup with some results, might return an empty list if execution succeeded
+without any results</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">400</span></td>
+ <td><span class="response-condition">Invalid fulltext or query parameters</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" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+ <td><span class="response-description">Search results</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/search/basic
+Accept: application/json
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "queryType" : "BASIC",
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ]
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_DiscoveryREST_searchUsingDSL_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/dsl <a href="../v2/search/dsl" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -85,6 +258,12 @@
</thead>
<tbody>
<tr>
+ <td><span class="parameter-name">classification</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
<td><span class="parameter-name">limit</span></td>
<td>query</td>
<td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
@@ -102,6 +281,12 @@
<td><span class="parameter-description">DSL query</span></td>
<td><span class="parameter-constraints"> </span></td>
</tr>
+ <tr>
+ <td><span class="parameter-name">typeName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
</tbody>
</table>
@@ -164,11 +349,13 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "queryText" : "...",
"queryType" : "DSL",
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -194,7 +381,7 @@ Content-Type: application/json
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -322,11 +509,13 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
+ "queryType" : "BASIC",
"queryText" : "...",
- "queryType" : "GREMLIN",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -336,7 +525,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/api/v2/resource_EntityREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_EntityREST.html b/api/v2/resource_EntityREST.html
index 0482c1b..6d72790 100644
--- a/api/v2/resource_EntityREST.html
+++ b/api/v2/resource_EntityREST.html
@@ -57,12 +57,12 @@
<li><a href="#resource_EntityREST_addClassification_POST"><abbr title="POST /v2/entity/bulk/classification">POST /v2/entity/bulk/classific...</abbr></a></li>
<li><a href="#resource_EntityREST_deleteByGuid_DELETE">DELETE /v2/entity/guid/{guid}</a></li>
<li><a href="#resource_EntityREST_getById_GET">GET /v2/entity/guid/{guid}</a></li>
+ <li><a href="#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT">PUT /v2/entity/guid/{guid}</a></li>
<li><a href="#resource_EntityREST_getClassifications_GET"><abbr title="GET /v2/entity/guid/{guid}/classifications">GET /v2/entity/guid/{guid}/cla...</abbr></a></li>
<li><a href="#resource_EntityREST_addClassifications_POST"><abbr title="POST /v2/entity/guid/{guid}/classifications">POST /v2/entity/guid/{guid}/cl...</abbr></a></li>
- <li><a href="#resource_EntityREST_updateClassifications_PUT"><abbr title="PUT /v2/entity/guid/{guid}/classifications">PUT /v2/entity/guid/{guid}/cla...</abbr></a></li>
<li><a href="#resource_EntityREST_deleteByUniqueAttribute_DELETE"><abbr title="DELETE /v2/entity/uniqueAttribute/type/{typeName}">DELETE /v2/entity/uniqueAttrib...</abbr></a></li>
<li><a href="#resource_EntityREST_getByUniqueAttributes_GET"><abbr title="GET /v2/entity/uniqueAttribute/type/{typeName}">GET /v2/entity/uniqueAttribute...</abbr></a></li>
- <li><a href="#resource_EntityREST_partialUpdateByUniqueAttributes_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}">PUT /v2/entity/uniqueAttribute...</abbr></a></li>
+ <li><a href="#resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT"><abbr title="PUT /v2/entity/uniqueAttribute/type/{typeName}">PUT /v2/entity/uniqueAttribute...</abbr></a></li>
<li><a href="#resource_EntityREST_deleteClassification_DELETE"><abbr title="DELETE /v2/entity/guid/{guid}/classification/{classificationName}">DELETE /v2/entity/guid/{guid}/...</abbr></a></li>
<li><a href="#resource_EntityREST_getClassification_GET"><abbr title="GET /v2/entity/guid/{guid}/classification/{classificationName}">GET /v2/entity/guid/{guid}/cla...</abbr></a></li>
<li class="divider"></li>
@@ -137,7 +137,7 @@ Accept: application/json
{
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -254,7 +254,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -264,7 +264,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -280,7 +280,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -290,7 +290,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -301,7 +301,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -311,7 +311,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -332,7 +332,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -343,7 +343,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -375,7 +375,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -467,7 +467,7 @@ Content-Type: application/json
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -524,7 +524,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -556,7 +556,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -577,7 +577,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -609,7 +609,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -620,7 +620,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -781,7 +781,7 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -1022,7 +1022,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1059,7 +1059,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1069,7 +1069,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1122,7 +1122,7 @@ Content-Type: application/json
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1281,7 +1281,7 @@ Content-Type: application/json
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1328,7 +1328,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1349,7 +1349,7 @@ Content-Type: application/json
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1359,7 +1359,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1370,7 +1370,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1380,7 +1380,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1391,7 +1391,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1401,7 +1401,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1434,7 +1434,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1542,7 +1542,7 @@ Content-Type: application/json
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -1569,7 +1569,7 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -1603,10 +1603,13 @@ Content-Type: application/json
</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>
+ <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>Gets the list of classifications for a given entity represented by a guid.</p>
+ <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>
@@ -1621,7 +1624,29 @@ Content-Type: application/json
<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>
+ <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" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">object
+ (JSON)</span></td>
</tr>
</tbody>
</table>
@@ -1632,15 +1657,13 @@ Content-Type: application/json
<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" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasClassifications.html">AtlasClassifications</a>
+ <td><span class="datatype-reference"><a href="json_EntityMutationResponse.html">EntityMutationResponse</a>
(JSON)</span></td>
- <td><span class="response-description">a list of classifications for the given entity guid</span></td>
</tr>
</tbody>
</table>
@@ -1651,25 +1674,188 @@ Content-Type: application/json
<div class="col-md-6">
<h5>Request</h5>
<pre>
-GET /v2/entity/guid/{guid}/classifications
+PUT /v2/entity/guid/{guid}
+Content-Type: application/json
Accept: application/json
+ <code class="prettyprint language-txt">
+...
+ </code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
-HTTP/1.1 200 OK
+HTTP/1.1 204 No Content
Content-Type: application/json
<code class="prettyprint language-js">
{
- "list" : [ { }, { } ],
- "startIndex" : 12345,
- "pageSize" : 12345,
- "totalCount" : 12345,
- "sortType" : "DESC",
- "sortBy" : "..."
+ "mutatedEntities" : {
+ "property1" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "property2" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ },
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "createdEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "updatedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "partialUpdatedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "deletedEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "firstEntityCreated" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityUpdated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityPartialUpdated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
}
</code>
</pre>
@@ -1678,10 +1864,10 @@ Content-Type: application/json
</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>
+ <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>Adds classifications to an existing entity represented by a guid.</p>
+ <p>Gets the list of classifications for a given entity represented by a guid.</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
@@ -1701,19 +1887,21 @@ Content-Type: application/json
</tbody>
</table>
- <table class="table resource-request-body">
- <caption>Request Body</caption>
+ <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 "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>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasClassifications.html">AtlasClassifications</a>
(JSON)</span></td>
+ <td><span class="response-description">a list of classifications for the given entity guid</span></td>
</tr>
</tbody>
</table>
@@ -1724,36 +1912,37 @@ Content-Type: application/json
<div class="col-md-6">
<h5>Request</h5>
<pre>
-POST /v2/entity/guid/{guid}/classifications
-Content-Type: application/json
+GET /v2/entity/guid/{guid}/classifications
+Accept: 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
+HTTP/1.1 200 OK
+Content-Type: application/json
+ <code class="prettyprint language-js">
+{
+ "list" : [ { }, { } ],
+ "startIndex" : 12345,
+ "pageSize" : 12345,
+ "totalCount" : 12345,
+ "sortType" : "ASC",
+ "sortBy" : "..."
+}
+ </code>
</pre>
</div>
</div>
</div>
</div>
- <div id="resource_EntityREST_updateClassifications_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>
+ <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>Update classification(s) for an entity represented by a guid.
-Classifications are identified by their guid or name</p>
+ <p>Adds classifications to an existing entity represented by a guid.</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
@@ -1796,7 +1985,7 @@ Classifications are identified by their guid or name</p>
<div class="col-md-6">
<h5>Request</h5>
<pre>
-PUT /v2/entity/guid/{guid}/classifications
+POST /v2/entity/guid/{guid}/classifications
Content-Type: application/json
<code class="prettyprint language-js">
@@ -1813,7 +2002,7 @@ Content-Type: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
-HTTP/1.1 204 No Content
+HTTP/1.1 201 Created
</pre>
</div>
@@ -1906,7 +2095,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1932,7 +2121,7 @@ Content-Type: application/json
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1942,7 +2131,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1974,7 +2163,7 @@ Content-Type: application/json
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1984,7 +2173,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2016,7 +2205,7 @@ Content-Type: application/json
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2038,7 +2227,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2118,7 +2307,7 @@ Content-Type: application/json
{
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -2173,7 +2362,7 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -2207,7 +2396,7 @@ Content-Type: application/json
</div>
</div>
- <div id="resource_EntityREST_partialUpdateByUniqueAttributes_PUT">
+ <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
@@ -2243,7 +2432,7 @@ Null updates are not possible</p>
<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_AtlasEntity.html">AtlasEntity</a>
+ <td><span class="datatype-reference"><a href="json_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</a>
(JSON)</span></td>
</tr>
</tbody>
@@ -2278,30 +2467,88 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "guid" : "...",
- "status" : "ACTIVE",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "classifications" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
"typeName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
}
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
+ },
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
}
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
}
}
</code>
@@ -2328,7 +2575,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2339,7 +2586,7 @@ Content-Type: application/json
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2428,7 +2675,7 @@ Content-Type: application/json
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2438,7 +2685,7 @@ Content-Type: application/json
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2460,7 +2707,7 @@ Content-Type: application/json
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2471,7 +2718,7 @@ Content-Type: application/json
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2506,7 +2753,7 @@ Content-Type: application/json
<tr>
<td><span class="parameter-name">classificationName</span></td>
<td>path</td>
- <td><span class="parameter-description">name of the trait</span></td>
+ <td><span class="parameter-description">name of the classifcation</span></td>
</tr>
<tr>
<td><span class="parameter-name">guid</span></td>
@@ -2579,7 +2826,7 @@ HTTP/1.1 204 No Content
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_AtlasClassification.html">AtlasClassification</a>
(JSON)</span></td>
- <td><span class="response-description">a list of classifications for the given entity guid</span></td>
+ <td><span class="response-description">classification for the given entity guid</span></td>
</tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/api/v2/resource_LineageREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_LineageREST.html b/api/v2/resource_LineageREST.html
index 5d0da52..1360880 100644
--- a/api/v2/resource_LineageREST.html
+++ b/api/v2/resource_LineageREST.html
@@ -174,7 +174,7 @@ Content-Type: application/json
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -185,7 +185,7 @@ Content-Type: application/json
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -202,7 +202,7 @@ Content-Type: application/json
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "BOTH",
+ "lineageDirection" : "OUTPUT",
"lineageDepth" : 12345
}
</code>