You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ni...@apache.org on 2018/11/01 14:41:25 UTC
[79/86] atlas-website git commit: ATLAS-2913 : 0.8.3 Api
documentation from swagger
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/2f6afcd8/0.8.3/api/v2/apidocs/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/0.8.3/api/v2/apidocs/resource_DiscoveryREST.html b/0.8.3/api/v2/apidocs/resource_DiscoveryREST.html
deleted file mode 100644
index d228fc8..0000000
--- a/0.8.3/api/v2/apidocs/resource_DiscoveryREST.html
+++ /dev/null
@@ -1,2763 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
-
- <title>Atlas REST API: DiscoveryREST</title>
-
- <!-- Mobile viewport optimized: j.mp/bplateviewport -->
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <!-- Bootstrap core CSS -->
- <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">
-
- <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
- <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
- <![endif]-->
-</head>
-
-<body data-spy="scroll" data-target="#apinav">
-
- <nav class="navbar navbar-inverse navbar-fixed-top">
- <div class="container-fluid">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a class="navbar-brand" href="index.html">Atlas REST API: DiscoveryREST</a>
- </div>
- <div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav navbar-right">
- <li><a href="resources.html">Resources</a></li>
- <li><a href="data.html">Data Types</a></li>
- </ul>
- </div>
- </div>
- </nav>
-
- <div class="container-fluid">
- <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_searchRelatedEntities_GET">GET /v2/search/relationship</a></li>
- <li><a href="#resource_DiscoveryREST_getSavedSearches_GET">GET /v2/search/saved</a></li>
- <li><a href="#resource_DiscoveryREST_addSavedSearch_POST">POST /v2/search/saved</a></li>
- <li><a href="#resource_DiscoveryREST_updateSavedSearch_PUT">PUT /v2/search/saved</a></li>
- <li><a href="#resource_DiscoveryREST_deleteSavedSearch_DELETE">DELETE /v2/search/saved/{guid}</a></li>
- <li><a href="#resource_DiscoveryREST_getSavedSearch_GET">GET /v2/search/saved/{name}</a></li>
- <li><a href="#resource_DiscoveryREST_executeSavedSearchByName_GET"><abbr title="GET /v2/search/saved/execute/{name}">GET /v2/search/saved/execute/{...</abbr></a></li>
- <li><a href="#resource_DiscoveryREST_executeSavedSearchByGuid_GET"><abbr title="GET /v2/search/saved/execute/guid/{guid}">GET /v2/search/saved/execute/g...</abbr></a></li>
- <li class="divider"></li>
- <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
- </ul>
- </div>
-
- <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
- <ol class="breadcrumb" id="top">
- <li class="active dropdown"><a href="index.html">Home</a></li>
- <li class="active dropdown"><a href="resources.html">Resources</a></li>
- <li class="dropdown"><a href="resource_DiscoveryREST.html">DiscoveryREST</a></li>
- </ol>
-
- <h1 class="page-header">DiscoveryREST <small>Resource</small></h1>
-
- <p>REST interface for data discovery using dsl or full text search</p>
-
- <div id="resource_DiscoveryREST_searchUsingAttribute_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/attribute <a href="../v2/search/attribute" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
-
- <p>Retrieve data for the specified attribute search query</p>
-
- <table class="table resource-parameters">
- <caption>Request Parameters</caption>
- <thead>
- <tr>
- <th>name</th>
- <th>type</th>
- <th>description</th>
- <th>constraints</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="parameter-name">attrName</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">attrValuePrefix</span></td>
- <td>query</td>
- <td><span class="parameter-description">Attibute value to search on</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">typeName</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-codes">
- <caption>Response Codes</caption>
- <thead>
- <tr>
- <th>code</th>
- <th>condition</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="label label-success response-code">200</span></td>
- <td><span class="response-condition">On successful FullText lookup with some results, might return an empty list if execution succeeded
-without any results</span></td>
- </tr>
- <tr>
- <td><span class="label label-warning response-code">400</span></td>
- <td><span class="response-condition">Invalid wildcard or query parameters</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <h4>Example</h4>
-
- <div class="container-fluid example panel">
- <div class="row panel-body">
- <div class="col-md-6">
- <h5>Request</h5>
- <pre>
-GET /v2/search/attribute
-Accept: application/json
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "GREMLIN",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "EQ",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </code>
- </pre>
- </div>
- </div>
- </div>
- </div>
-
- <div id="resource_DiscoveryREST_searchUsingBasic_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
-
- <p>Retrieve data for the specified fulltext query</p>
-
- <table class="table resource-parameters">
- <caption>Request Parameters</caption>
- <thead>
- <tr>
- <th>name</th>
- <th>type</th>
- <th>description</th>
- <th>constraints</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="parameter-name">classification</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">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">limit</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">offset</span></td>
- <td>query</td>
- <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">query</span></td>
- <td>query</td>
- <td><span class="parameter-description">Fulltext query</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">typeName</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-codes">
- <caption>Response Codes</caption>
- <thead>
- <tr>
- <th>code</th>
- <th>condition</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="label label-success response-code">200</span></td>
- <td><span class="response-condition">On successful FullText lookup with some results, might return an empty list if execution succeeded
-without any results</span></td>
- </tr>
- <tr>
- <td><span class="label label-warning response-code">400</span></td>
- <td><span class="response-condition">Invalid fulltext or query parameters</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <h4>Example</h4>
-
- <div class="container-fluid example panel">
- <div class="row panel-body">
- <div class="col-md-6">
- <h5>Request</h5>
- <pre>
-GET /v2/search/basic
-Accept: application/json
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "RELATIONSHIP",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "STARTS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "NEQ",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </code>
- </pre>
- </div>
- </div>
- </div>
- </div>
-
- <div id="resource_DiscoveryREST_searchWithParameters_POST">
- <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/basic <a href="../v2/search/basic" 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-request-body">
- <caption>Request Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_SearchParameters.html">SearchParameters</a>
- (JSON)</span></td>
- <td><span class="request-description">Search parameters</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">Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">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>
-POST /v2/search/basic
-Content-Type: application/json
-Accept: application/json
-
- <code class="prettyprint language-js">
-{
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "STARTS_WITH",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "DSL",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "ENDS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GT",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </code>
- </pre>
- </div>
- </div>
- </div>
- </div>
-
- <div id="resource_DiscoveryREST_searchUsingDSL_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/dsl <a href="../v2/search/dsl" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
-
- <p>Retrieve data for the specified DSL</p>
-
- <table class="table resource-parameters">
- <caption>Request Parameters</caption>
- <thead>
- <tr>
- <th>name</th>
- <th>type</th>
- <th>description</th>
- <th>constraints</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="parameter-name">classification</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result to only entities tagged with the given classification or or its sub-types</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">limit</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">offset</span></td>
- <td>query</td>
- <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">query</span></td>
- <td>query</td>
- <td><span class="parameter-description">DSL query</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">typeName</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result to only entities of specified type or its sub-types</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- </tbody>
- </table>
-
- <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 DSL execution with some results, might return an empty list if execution succeeded
-without any results</span></td>
- </tr>
- <tr>
- <td><span class="label label-warning response-code">400</span></td>
- <td><span class="response-condition">Invalid DSL or query parameters</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <h4>Example</h4>
-
- <div class="container-fluid example panel">
- <div class="row panel-body">
- <div class="col-md-6">
- <h5>Request</h5>
- <pre>
-GET /v2/search/dsl
-Accept: application/json
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "GREMLIN",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "NOT_NULL",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "LT",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </code>
- </pre>
- </div>
- </div>
- </div>
- </div>
-
- <div id="resource_DiscoveryREST_searchUsingFullText_GET">
- <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/fulltext <a href="../v2/search/fulltext" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
-
- <p>Retrieve data for the specified fulltext query</p>
-
- <table class="table resource-parameters">
- <caption>Request Parameters</caption>
- <thead>
- <tr>
- <th>name</th>
- <th>type</th>
- <th>description</th>
- <th>constraints</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="parameter-name">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">limit</span></td>
- <td>query</td>
- <td><span class="parameter-description">limit the result set to only include the specified number of entries</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">offset</span></td>
- <td>query</td>
- <td><span class="parameter-description">start offset of the result set (useful for pagination)</span></td>
- <td><span class="parameter-constraints">int</span></td>
- </tr>
- <tr>
- <td><span class="parameter-name">query</span></td>
- <td>query</td>
- <td><span class="parameter-description">Fulltext query</span></td>
- <td><span class="parameter-constraints"> </span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-codes">
- <caption>Response Codes</caption>
- <thead>
- <tr>
- <th>code</th>
- <th>condition</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="label label-success response-code">200</span></td>
- <td><span class="response-condition">On successful FullText lookup with some results, might return an empty list if execution succeeded
-without any results</span></td>
- </tr>
- <tr>
- <td><span class="label label-warning response-code">400</span></td>
- <td><span class="response-condition">Invalid fulltext or query parameters</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <h4>Example</h4>
-
- <div class="container-fluid example panel">
- <div class="row panel-body">
- <div class="col-md-6">
- <h5>Request</h5>
- <pre>
-GET /v2/search/fulltext
-Accept: application/json
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "ATTRIBUTE",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "LTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "NOT_NULL",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </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" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">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
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "DSL",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "LTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GT",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
- },
- "fullTextResult" : [ {
- "entity" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- }, {
- "entity" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ { }, { } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "score" : 12345.0
- } ],
- "referredEntities" : {
- "property1" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "property2" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
- }
-}
- </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" 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><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
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-[ {
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "ADVANCED",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "CONTAINS_ANY",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-} ]
- </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" 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_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
- (JSON)</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
- (JSON)</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
-Accept: application/json
-
- <code class="prettyprint language-js">
-{
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 201 Created
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "NOT_NULL",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-}
- </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" 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_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
- (JSON)</span></td>
- </tr>
- </tbody>
- </table>
-
- <table class="table resource-response-body">
- <caption>Response Body</caption>
- <thead>
- <tr>
- <th>media type</th>
- <th>data type</th>
- <th>description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
- (JSON)</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
-Accept: application/json
-
- <code class="prettyprint language-js">
-{
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "ENDS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "LIKE",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-}
- </code>
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 204 No Content
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "CONTAINS_ANY",
- "attributeValue" : "...",
- "condition" : "AND",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "GTE",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-}
- </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>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>
- (JSON)</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
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "ownerName" : "...",
- "name" : "...",
- "searchType" : "BASIC",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "EQ",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "IN",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "uiParameters" : "...",
- "guid" : "..."
-}
- </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" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
- <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a>
- (JSON)</span></td>
- <td><span class="response-description">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
-
- </pre>
- </div>
- <div class="col-md-6">
- <h5>Response</h5>
- <pre>
-HTTP/1.1 200 OK
-Content-Type: application/json
-
- <code class="prettyprint language-js">
-{
- "queryType" : "ATTRIBUTE",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "includeClassificationAttributes" : true,
- "includeSubTypes" : true,
- "includeSubClassifications" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "LT",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "NOT_NULL",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...&qu
<TRUNCATED>