| <!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://stackpath.bootstrapcdn.com/bootstrap/3.4.1/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">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"><abbr title="GET /v2/search/attribute" class="side-abbr"><span class="sideoverflow">GET /v2/search/attribute</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_searchUsingBasic_GET"><abbr title="GET /v2/search/basic" class="side-abbr"><span class="sideoverflow">GET /v2/search/basic</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_searchWithParameters_POST"><abbr title="POST /v2/search/basic" class="side-abbr"><span class="sideoverflow">POST /v2/search/basic</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_searchUsingDSL_GET"><abbr title="GET /v2/search/dsl" class="side-abbr"><span class="sideoverflow">GET /v2/search/dsl</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_searchUsingFullText_GET"><abbr title="GET /v2/search/fulltext" class="side-abbr"><span class="sideoverflow">GET /v2/search/fulltext</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_quickSearch_GET"><abbr title="GET /v2/search/quick" class="side-abbr"><span class="sideoverflow">GET /v2/search/quick</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_quickSearch_POST"><abbr title="POST /v2/search/quick" class="side-abbr"><span class="sideoverflow">POST /v2/search/quick</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_relationSearch_GET"><abbr title="GET /v2/search/relations" class="side-abbr"><span class="sideoverflow">GET /v2/search/relations</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_relationSearch_POST"><abbr title="POST /v2/search/relations" class="side-abbr"><span class="sideoverflow">POST /v2/search/relations</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_searchRelatedEntities_GET"><abbr title="GET /v2/search/relationship" class="side-abbr"><span class="sideoverflow">GET /v2/search/relationship</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_getSavedSearches_GET"><abbr title="GET /v2/search/saved" class="side-abbr"><span class="sideoverflow">GET /v2/search/saved</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_addSavedSearch_POST"><abbr title="POST /v2/search/saved" class="side-abbr"><span class="sideoverflow">POST /v2/search/saved</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_updateSavedSearch_PUT"><abbr title="PUT /v2/search/saved" class="side-abbr"><span class="sideoverflow">PUT /v2/search/saved</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_getSuggestions_GET"><abbr title="GET /v2/search/suggestions" class="side-abbr"><span class="sideoverflow">GET /v2/search/suggestions</span></abbr></a></li> |
| <li><a href="#resource_DiscoveryREST_deleteSavedSearch_DELETE"><abbr title="DELETE /v2/search/saved/{guid}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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}" class="side-abbr"><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">required</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">required</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LTE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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">required</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">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">marker</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </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">required</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">sortBy</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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"></span></td> |
| <td><span class="parameter-constraints">"ASCENDING" or "DESCENDING"</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="request-description">Search parameters</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" 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> |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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"> |
| { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "IN" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| } |
| </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"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "ATTRIBUTE", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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">required</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">required</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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">required</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">required</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">required</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 rowspan="2" class="multi-row-description"><span class="response-description">Search results</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_DiscoveryREST_quickSearch_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/quick <a href="../v2/search/quick" 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> |
| <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">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">query</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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"></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"></span></td> |
| <td><span class="parameter-constraints">"ASCENDING" or "DESCENDING"</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">typeName</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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 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_AtlasQuickSearchResult.html">AtlasQuickSearchResult</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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_AtlasQuickSearchResult.html">AtlasQuickSearchResult</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/quick |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_DiscoveryREST_quickSearch_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/quick <a href="../v2/search/quick" 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> |
| </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_QuickSearchParameters.html">QuickSearchParameters</a> |
| (JSON)</span></td> |
| </tr> |
| <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_QuickSearchParameters.html">QuickSearchParameters</a> |
| (JSON)</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">Entity/attribute doesn't exist or entity filter is present without 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_AtlasQuickSearchResult.html">AtlasQuickSearchResult</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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_AtlasQuickSearchResult.html">AtlasQuickSearchResult</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> |
| POST /v2/search/quick |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "attributes" : [ "...", "..." ], |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "offset" : 12345, |
| "query" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "typeName" : "..." |
| } |
| </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"> |
| { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_DiscoveryREST_relationSearch_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/relations <a href="../v2/search/relations" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Relationship search to search for relations(edges)</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">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">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">marker</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </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">required</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">relationshipName</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">AtlasRelationshipType name</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> |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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/relations |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "BASIC", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_DiscoveryREST_relationSearch_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/search/relations <a href="../v2/search/relations" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Relationship search to search for relations(edges)</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_RelationshipSearchParameters.html">RelationshipSearchParameters</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">RelationshipSearchParameters</span></td> |
| </tr> |
| <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_RelationshipSearchParameters.html">RelationshipSearchParameters</a> |
| (JSON)</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> |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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/relations |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING" |
| } |
| </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"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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> |
| <th>multivalued</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">attributes</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">set of attributes in search result.</span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| <td><span class="parameter-multivalued">yes</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">required</span></td> |
| <td><span class="parameter-multivalued">no</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">getApproximateCount</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">required</span></td> |
| <td><span class="parameter-multivalued">no</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> |
| <td><span class="parameter-multivalued">no</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">includeClassificationAttributes</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">required</span></td> |
| <td><span class="parameter-multivalued">no</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">required</span></td> |
| <td><span class="parameter-multivalued">no</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">required</span></td> |
| <td><span class="parameter-multivalued">no</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> |
| <td><span class="parameter-multivalued">no</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> |
| <td><span class="parameter-multivalued">no</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> |
| <td><span class="parameter-multivalued">no</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 rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IN" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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 rowspan="2" class="multi-row-description"><span class="response-description">list of all saved searches for given user</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "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> |
| </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 |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "STARTS_WITH" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "ADVANCED", |
| "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> |
| <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 rowspan="2" class="multi-row-description"><span class="response-description">the saved search-object</span></td> |
| </tr> |
| <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> |
| POST /v2/search/saved |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC", |
| "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"> |
| { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "STARTS_WITH" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "ADVANCED", |
| "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> |
| <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 rowspan="2" class="multi-row-description"><span class="response-description">the updated search-object</span></td> |
| </tr> |
| <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> |
| PUT /v2/search/saved |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IN" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC", |
| "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"> |
| { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "ADVANCED", |
| "uiParameters" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_DiscoveryREST_getSuggestions_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/search/suggestions <a href="../v2/search/suggestions" 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">fieldName</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">prefixString</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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_AtlasSuggestionsResult.html">AtlasSuggestionsResult</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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_AtlasSuggestionsResult.html">AtlasSuggestionsResult</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/suggestions |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "fieldName" : "...", |
| "prefixString" : "...", |
| "suggestions" : [ "...", "..." ] |
| } |
| </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} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </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" 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 rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC_RELATIONSHIP", |
| "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 rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "BASIC", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> |
| <td><span class="datatype-reference"><a href="json_AtlasSearchResult.html">AtlasSearchResult</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Atlas search result</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" 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> |
| </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} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <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 |
| |
| <code class="prettyprint language-js"> |
| { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| </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://code.jquery.com/jquery-1.12.2.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdn.jsdelivr.net/gh/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> |