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:55 UTC
[13/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/1.1.0/api/v2/resource_LineageREST.html
----------------------------------------------------------------------
diff --git a/1.1.0/api/v2/resource_LineageREST.html b/1.1.0/api/v2/resource_LineageREST.html
index 93e5769..7320f3c 100644
--- a/1.1.0/api/v2/resource_LineageREST.html
+++ b/1.1.0/api/v2/resource_LineageREST.html
@@ -143,10 +143,15 @@
</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_AtlasLineageInfo.html">AtlasLineageInfo</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">AtlasLineageInfo</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">AtlasLineageInfo</span></td>
</tr>
</tbody>
</table>
@@ -158,8 +163,8 @@
<h5>Request</h5>
<pre>
GET /v2/lineage/{guid}
-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">
...
@@ -170,10 +175,141 @@ 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">
+{
+ "baseEntityGuid" : "...",
+ "guidEntityMap" : {
+ "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" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "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" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "lineageDepth" : 12345,
+ "lineageDirection" : "OUTPUT",
+ "relations" : [ {
+ "fromEntityId" : "...",
+ "relationshipId" : "...",
+ "toEntityId" : "..."
+ }, {
+ "fromEntityId" : "...",
+ "relationshipId" : "...",
+ "toEntityId" : "..."
+ } ]
+}
</code>
</pre>
</div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/d115dad8/1.1.0/api/v2/resource_RelationshipREST.html
----------------------------------------------------------------------
diff --git a/1.1.0/api/v2/resource_RelationshipREST.html b/1.1.0/api/v2/resource_RelationshipREST.html
index c95271d..8239ae9 100644
--- a/1.1.0/api/v2/resource_RelationshipREST.html
+++ b/1.1.0/api/v2/resource_RelationshipREST.html
@@ -85,6 +85,11 @@
</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_AtlasRelationship.html">AtlasRelationship</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>
@@ -103,10 +108,15 @@
</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_AtlasRelationship.html">AtlasRelationship</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>
@@ -118,11 +128,121 @@
<h5>Request</h5>
<pre>
POST /v2/relationship
-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">
+{
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "guid" : "...",
+ "homeId" : "...",
+ "label" : "...",
+ "propagateTags" : "BOTH",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+}
</code>
</pre>
</div>
@@ -130,10 +250,120 @@ 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">
+{
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "guid" : "...",
+ "homeId" : "...",
+ "label" : "...",
+ "propagateTags" : "TWO_TO_ONE",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+}
</code>
</pre>
</div>
@@ -156,6 +386,11 @@ Content-Type: application/json;charset=UTF-8
</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_AtlasRelationship.html">AtlasRelationship</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>
@@ -174,10 +409,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_AtlasRelationship.html">AtlasRelationship</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>
@@ -189,11 +429,121 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
PUT /v2/relationship
-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">
+{
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "guid" : "...",
+ "homeId" : "...",
+ "label" : "...",
+ "propagateTags" : "BOTH",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+}
</code>
</pre>
</div>
@@ -201,10 +551,120 @@ 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">
+{
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "createTime" : 12345,
+ "createdBy" : "...",
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "guid" : "...",
+ "homeId" : "...",
+ "label" : "...",
+ "propagateTags" : "NONE",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+}
</code>
</pre>
</div>
@@ -242,7 +702,7 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
DELETE /v2/relationship/guid/{guid}
-Content-Type: application/json;charset=UTF-8
+Content-Type: application/json
<code class="prettyprint language-txt">
...
@@ -305,10 +765,15 @@ HTTP/1.1 204 No Content
</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_AtlasRelationshipWithExtInfo.html">AtlasRelationshipWithExtInfo</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>
@@ -320,8 +785,8 @@ HTTP/1.1 204 No Content
<h5>Request</h5>
<pre>
GET /v2/relationship/guid/{guid}
-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">
...
@@ -332,10 +797,208 @@ 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">
+{
+ "referredEntities" : {
+ "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" : "IMPORTED",
+ "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" : "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "relationship" : {
+ "blockedPropagatedClassifications" : [ {
+ "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" : "...",
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "guid" : "...",
+ "homeId" : "...",
+ "label" : "...",
+ "propagateTags" : "NONE",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ { }, { } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "status" : "DELETED",
+ "updateTime" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+}
</code>
</pre>
</div>