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:58 UTC
[16/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_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/1.1.0/api/v2/resource_DiscoveryREST.html b/1.1.0/api/v2/resource_DiscoveryREST.html
index cea178c..e26c89a 100644
--- a/1.1.0/api/v2/resource_DiscoveryREST.html
+++ b/1.1.0/api/v2/resource_DiscoveryREST.html
@@ -160,10 +160,15 @@ without any results</span></td>
</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</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">Search results</span></td>
</tr>
</tbody>
</table>
@@ -175,8 +180,8 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/attribute
-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">
...
@@ -187,10 +192,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "ATTRIBUTE",
+ "referredEntities" : {
+ "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" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "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" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "LIKE"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "GTE"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -285,10 +592,15 @@ without any results</span></td>
</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</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">Search results</span></td>
</tr>
</tbody>
</table>
@@ -300,8 +612,8 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/basic
-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">
...
@@ -312,10 +624,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "OBSOLETE",
+ "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" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "BASIC",
+ "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" : "OTHER",
+ "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" : "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" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "CONTAINS"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "IN"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -339,10 +953,15 @@ 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_SearchParameters.html">SearchParameters</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">Search parameters</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>
- <td><span class="request-description">Search parameters</span></td>
</tr>
</tbody>
</table>
@@ -378,10 +997,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_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</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">Atlas search result</span></td>
</tr>
</tbody>
</table>
@@ -393,11 +1017,37 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
POST /v2/search/basic
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "EQ"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "LTE"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+}
</code>
</pre>
</div>
@@ -405,10 +1055,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "..."
+ }, {
+ "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" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "ATTRIBUTE",
+ "referredEntities" : {
+ "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "VALIDATED",
+ "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" : "IMPORTED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "CONTAINS_ANY"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "ENDS_WITH"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -497,10 +1449,15 @@ without any results</span></td>
</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</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">Search results</span></td>
</tr>
</tbody>
</table>
@@ -512,8 +1469,8 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/dsl
-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">
...
@@ -524,10 +1481,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "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" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "FULL_TEXT",
+ "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" : "IMPORTED",
+ "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" : "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" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "GTE"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "ENDS_WITH"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -610,10 +1869,15 @@ without any results</span></td>
</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</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">Search results</span></td>
</tr>
</tbody>
</table>
@@ -625,8 +1889,8 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/fulltext
-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">
...
@@ -637,10 +1901,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "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" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "ATTRIBUTE",
+ "referredEntities" : {
+ "property1" : {
+ "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" : "IMPORTED",
+ "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" : "VALIDATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "PROPOSED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "IN"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "CONTAINS"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -740,10 +2306,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_AtlasSearchResult.html">AtlasSearchResult</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</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">Atlas search result</span></td>
</tr>
</tbody>
</table>
@@ -755,8 +2326,8 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
GET /v2/search/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">
...
@@ -767,10 +2338,312 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "classification" : "...",
+ "entities" : [ {
+ "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" : "DEPRECATED",
+ "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" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "fullTextResult" : [ {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "ACTIVE",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ { }, { } ],
+ "displayText" : "...",
+ "guid" : "...",
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ { }, { } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "score" : 12345.0
+ } ],
+ "queryText" : "...",
+ "queryType" : "ATTRIBUTE",
+ "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "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" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "confidence" : 12345,
+ "createdBy" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DISCOVERED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "status" : "DELETED",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }
+ },
+ "searchParameters" : {
+ "attributes" : [ "...", "..." ],
+ "classification" : "...",
+ "entityFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ],
+ "operator" : "LTE"
+ },
+ "excludeDeletedEntities" : true,
+ "includeClassificationAttributes" : true,
+ "includeSubClassifications" : true,
+ "includeSubTypes" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "query" : "...",
+ "tagFilters" : {
+ "attributeName" : "...",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ],
+ "operator" : "ENDS_WITH"
+ },
+ "termName" : "...",
+ "typeName" : "..."
+ },
+ "type" : "..."
+}
</code>
</pre>
</div>
@@ -812,10 +2685,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">array of <a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">list of all saved searches for given user</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accep
<TRUNCATED>