You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2018/10/22 16:14:48 UTC
[06/27] atlas-website git commit: Updated REST docs for 1.x releases
(part 2)
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/d115dad8/api/v2/resource_EntityREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_EntityREST.html b/api/v2/resource_EntityREST.html
index af806cf..e3743fc 100644
--- a/api/v2/resource_EntityREST.html
+++ b/api/v2/resource_EntityREST.html
@@ -103,6 +103,11 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</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_AtlasEntityWithExtInfo.html">AtlasEntityWithExtInfo</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>
@@ -121,10 +126,15 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</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_EntityMutationResponse.html">EntityMutationResponse</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">EntityMutationResponse</span></td>
+ </tr>
+ <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>
@@ -136,11 +146,212 @@ Existing entity is matched using its unique guid if supplied or by its unique at
<h5>Request</h5>
<pre>
POST /v2/entity
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "entity" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "referredEntities" : {
+ "property1" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "property2" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ }
+}
</code>
</pre>
</div>
@@ -148,10 +359,362 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "mutatedEntities" : {
+ "property1" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "property2" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+ },
+ "partialUpdatedEntities" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+}
</code>
</pre>
</div>
@@ -195,10 +758,15 @@ Content-Type: application/json;charset=UTF-8
</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_EntityMutationResponse.html">EntityMutationResponse</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <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>
@@ -210,8 +778,8 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
DELETE /v2/entity/bulk
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
<code class="prettyprint language-txt">
...
@@ -222,10 +790,362 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 204 No Content
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "mutatedEntities" : {
+ "property1" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "property2" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+ },
+ "partialUpdatedEntities" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+}
</code>
</pre>
</div>
@@ -281,10 +1201,15 @@ Content-Type: application/json;charset=UTF-8
</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <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>
@@ -296,8 +1221,8 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
GET /v2/entity/bulk
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
<code class="prettyprint language-txt">
...
@@ -308,10 +1233,276 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "entities" : [ {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "property2" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ }
+}
</code>
</pre>
</div>
@@ -335,6 +1526,11 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</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_AtlasEntitiesWithExtInfo.html">AtlasEntitiesWithExtInfo</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>
@@ -353,10 +1549,15 @@ Existing entity is matched using its unique guid if supplied or by its unique at
</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_EntityMutationResponse.html">EntityMutationResponse</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <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>
@@ -368,11 +1569,277 @@ Existing entity is matched using its unique guid if supplied or by its unique at
<h5>Request</h5>
<pre>
POST /v2/entity/bulk
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "entities" : [ {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "property2" : {
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "homeId" : "...",
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "proxy" : true,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ }
+}
</code>
</pre>
</div>
@@ -380,10 +1847,362 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "mutatedEntities" : {
+ "property1" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "property2" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+ },
+ "partialUpdatedEntities" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ]
+}
</code>
</pre>
</div>
@@ -431,7 +2250,7 @@ Content-Type: application/json
{
"classification" : {
"entityGuid" : "...",
- "entityStatus" : "DELETED",
+ "entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
@@ -499,10 +2318,15 @@ HTTP/1.1 201 Created
</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_EntityMutationResponse.html">EntityMutationResponse</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">EntityMutationResponse</span></td>
+ </tr>
+ <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>
@@ -515,7 +2339,7 @@ HTTP/1.1 201 Created
<pre>
DELETE /v2/entity/guid/{guid}
Content-Type: application/json
-Accept: application/json;charset=UTF-8
+Accept: application/json
<code class="prettyprint language-txt">
...
@@ -526,10 +2350,362 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 204 No Content
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
- <code class="prettyprint language-txt">
-...
+ <code class="prettyprint language-js">
+{
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "mutatedEntities" : {
+ "property1" : [ {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "displayText" : "...",
+ "guid" : "...&quo
<TRUNCATED>