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 00:52:53 UTC
[10/51] [partial] atlas-website git commit: ATLAS-2691: update Apache
Atlas website for 1.0.0 release
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/af60ed7f/1.0.0-rc0/api/v2/resource_DiscoveryREST.html
----------------------------------------------------------------------
diff --git a/1.0.0-rc0/api/v2/resource_DiscoveryREST.html b/1.0.0-rc0/api/v2/resource_DiscoveryREST.html
deleted file mode 100644
index 335a54a..0000000
--- a/1.0.0-rc0/api/v2/resource_DiscoveryREST.html
+++ /dev/null
@@ -1,1261 +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>Apache Atlas Web Application: 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/enunciate.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">Apache Atlas Web Application: 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>
- <li><a href="downloads.html">Files and Libraries</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"><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>
- </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
- <td><span class="datatype-reference">(custom)
-</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <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;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_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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
- <td><span class="datatype-reference">(custom)
-</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <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;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_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;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
- <td><span class="datatype-reference">(custom)
-</span></td>
- <td><span class="request-description">Search parameters</span></td>
- </tr>
- </tbody>
- </table>
-
- <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;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>
-POST /v2/search/basic
-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 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
- </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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
- <td><span class="datatype-reference">(custom)
-</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <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;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_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;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
- <td><span class="datatype-reference">(custom)
-</span></td>
- <td><span class="response-description">Search results</span></td>
- </tr>
- </tbody>
- </table>
- <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;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>
- <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_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>
- </div>
- </div>
- </div>
-
- <footer class="footer">
- <div class="container">
- <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
- </div>
- </footer>
-
- </div>
- </div>
- </div>
-
-
- <!-- JavaScript placed at the end of the document so the pages load faster. -->
- <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-
- <!-- Bootstrap core JavaScript
- ================================================== -->
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
-
- <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
- <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
- <script>
- $(function() {
- $(".clickable-row").click(function() {
- window.document.location = $(this).data("href");
- });
-
- $('[data-toggle="tooltip"]').tooltip()
- });
- </script>
-
-</body>
-</html>