You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2018/06/03 20:58:53 UTC
[25/31] atlas-website git commit: ATLAS-2691: updated documentation
to add Downloads page
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/api/v2/resource_DiscoveryREST.html b/api/v2/resource_DiscoveryREST.html
index 345313a..e35ff90 100644
--- a/api/v2/resource_DiscoveryREST.html
+++ b/api/v2/resource_DiscoveryREST.html
@@ -15,7 +15,7 @@
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
- <link rel="stylesheet" href="css/style.css">
+ <link rel="stylesheet" href="css/enunciate.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
@@ -50,11 +50,19 @@
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
- <li><a href="#resource_DiscoveryREST_searchUsingAttribute_GET">GET /v2/search/attribute</a></li>
- <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET">GET /v2/search/basic</a></li>
- <li><a href="#resource_DiscoveryREST_searchWithParameters_POST">POST /v2/search/basic</a></li>
- <li><a href="#resource_DiscoveryREST_searchUsingDSL_GET">GET /v2/search/dsl</a></li>
- <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET">GET /v2/search/fulltext</a></li>
+ <li><a href="#resource_DiscoveryREST_searchUsingAttribute_GET"><abbr title="GET /v2/search/attribute"><span class="sideoverflow">GET /v2/search/attribute</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET"><abbr title="GET /v2/search/basic"><span class="sideoverflow">GET /v2/search/basic</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_searchWithParameters_POST"><abbr title="POST /v2/search/basic"><span class="sideoverflow">POST /v2/search/basic</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_searchUsingDSL_GET"><abbr title="GET /v2/search/dsl"><span class="sideoverflow">GET /v2/search/dsl</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET"><abbr title="GET /v2/search/fulltext"><span class="sideoverflow">GET /v2/search/fulltext</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_searchRelatedEntities_GET"><abbr title="GET /v2/search/relationship"><span class="sideoverflow">GET /v2/search/relationship</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_getSavedSearches_GET"><abbr title="GET /v2/search/saved"><span class="sideoverflow">GET /v2/search/saved</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_addSavedSearch_POST"><abbr title="POST /v2/search/saved"><span class="sideoverflow">POST /v2/search/saved</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_updateSavedSearch_PUT"><abbr title="PUT /v2/search/saved"><span class="sideoverflow">PUT /v2/search/saved</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_deleteSavedSearch_DELETE"><abbr title="DELETE /v2/search/saved/{guid}"><span class="sideoverflow">DELETE /v2/search/saved/{guid}</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_getSavedSearch_GET"><abbr title="GET /v2/search/saved/{name}"><span class="sideoverflow">GET /v2/search/saved/{name}</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_executeSavedSearchByName_GET"><abbr title="GET /v2/search/saved/execute/{name}"><span class="sideoverflow">GET /v2/search/saved/execute/{name}</span></abbr></a></li>
+ <li><a href="#resource_DiscoveryREST_executeSavedSearchByGuid_GET"><abbr title="GET /v2/search/saved/execute/guid/{guid}"><span class="sideoverflow">GET /v2/search/saved/execute/guid/{guid}</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -152,9 +160,9 @@ 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><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>
@@ -167,7 +175,7 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/attribute
-Accept: application/json
+Accept: application/json;charset=UTF-8
</pre>
</div>
@@ -175,114 +183,10 @@ Accept: application/json
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "GREMLIN",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "GT",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "LIKE",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>
@@ -377,9 +281,9 @@ 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><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>
@@ -392,7 +296,7 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/basic
-Accept: application/json
+Accept: application/json;charset=UTF-8
</pre>
</div>
@@ -400,114 +304,10 @@ Accept: application/json
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "STARTS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>
@@ -531,9 +331,9 @@ Content-Type: application/json
</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><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>
@@ -570,9 +370,9 @@ Content-Type: application/json
</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><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>
@@ -585,33 +385,11 @@ Content-Type: application/json
<h5>Request</h5>
<pre>
POST /v2/search/basic
-Content-Type: application/json
-Accept: application/json
-
- <code class="prettyprint language-js">
-{
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "NEQ",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
-}
+Content-Type: application/json;charset=UTF-8
+Accept: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>
@@ -619,114 +397,10 @@ Accept: application/json
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "DSL",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "CONTAINS",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>
@@ -815,9 +489,9 @@ 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><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>
@@ -830,7 +504,7 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/dsl
-Accept: application/json
+Accept: application/json;charset=UTF-8
</pre>
</div>
@@ -838,114 +512,10 @@ Accept: application/json
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "GREMLIN",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "NEQ",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "CONTAINS",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>
@@ -1028,9 +598,9 @@ 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><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>
@@ -1043,7 +613,201 @@ without any results</span></td>
<h5>Request</h5>
<pre>
GET /v2/search/fulltext
-Accept: application/json
+Accept: application/json;charset=UTF-8
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_searchRelatedEntities_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/relationship <a href="../v2/search/relationship" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Relationship search to search for related entities satisfying the search parameters</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ <th>constraints</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">excludeDeletedEntities</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-constraints">boolean</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">guid</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">Attribute name</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">limit</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">offset</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
+ <td><span class="parameter-constraints">int</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">relation</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">relationName</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">sortBy</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">sort the result using this attribute name, default value is 'name'</span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">sortOrder</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">sorting order</span></td>
+ <td><span class="parameter-constraints">"ASCENDING" or "DESCENDING"</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-codes">
+ <caption>Response Codes</caption>
+ <thead>
+ <tr>
+ <th>code</th>
+ <th>condition</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="label label-success response-code">200</span></td>
+ <td><span class="response-condition">On successful search</span></td>
+ </tr>
+ <tr>
+ <td><span class="label label-warning response-code">400</span></td>
+ <td><span class="response-condition">guid is not a valid entity type or attributeName is not a valid relationship attribute</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">Atlas search result</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/search/relationship
+Accept: application/json;charset=UTF-8
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_getSavedSearches_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">user</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">User for whom the search is retrieved</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">list of all saved searches for given user</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/search/saved
+Accept: application/json;charset=UTF-8
</pre>
</div>
@@ -1051,114 +815,410 @@ Accept: application/json
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "ATTRIBUTE",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "LTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "LTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_addSavedSearch_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-request-body">
+ <caption>Request Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;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>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">the saved search-object</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+POST /v2/search/saved
+Content-Type: application/json;charset=UTF-8
+Accept: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 201 Created
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_updateSavedSearch_PUT">
+ <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/search/saved <a href="../v2/search/saved" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-request-body">
+ <caption>Request Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;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>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">the updated search-object</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+PUT /v2/search/saved
+Content-Type: application/json;charset=UTF-8
+Accept: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 204 No Content
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_deleteSavedSearch_DELETE">
+ <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/search/saved/{guid} <a href="../v2/search/saved/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">guid</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">Name of the saved search</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+DELETE /v2/search/saved/{guid}
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 204 No Content
+
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_getSavedSearch_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/{name} <a href="../v2/search/saved/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">name</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">Name of the saved search</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">user</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">User for whom the search is retrieved</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description"></span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/search/saved/{name}
+Accept: application/json;charset=UTF-8
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_executeSavedSearchByName_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/execute/{name} <a href="../v2/search/saved/execute/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Attribute based search for entities satisfying the search parameters</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">name</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">name of saved-search</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">user</span></td>
+ <td>query</td>
+ <td><span class="parameter-description">saved-search owner</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">Atlas search result</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/search/saved/execute/{name}
+Accept: application/json;charset=UTF-8
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_DiscoveryREST_executeSavedSearchByGuid_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/saved/execute/guid/{guid} <a href="../v2/search/saved/execute/guid/{guid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p>Attribute based search for entities satisfying the search parameters</p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">guid</span></td>
+ <td>path</td>
+ <td><span class="parameter-description">Guid identifying saved search</span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
+ <td><span class="datatype-reference">(custom)
+</span></td>
+ <td><span class="response-description">Atlas search result</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /v2/search/saved/execute/guid/{guid}
+Accept: application/json;charset=UTF-8
+
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+
+ <code class="prettyprint language-txt">
+...
</code>
</pre>
</div>