| <!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: SearchParameters</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: SearchParameters</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 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="syntax_json.html">JSON</a></li> |
| <li class="dropdown"><a href="json_SearchParameters.html">SearchParameters</a></li> |
| </ol> |
| |
| <h1 class="page-header">SearchParameters <small>Data Type</small></h1> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| </dl> |
| |
| <table class="table datatype-properties"> |
| <caption>Properties</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>data type</th> |
| <th>constraints</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td> <span id="prop-attributes" class="property-name">attributes</span> |
| </td> |
| <td> <span class="datatype-reference">array of string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Attribute values included in the results</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-classification" class="property-name">classification</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Classification/tag to search on</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-entityFilters" class="property-name">entityFilters</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Entity attribute filters for the type (if type name is specified)</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-excludeDeletedEntities" class="property-name">excludeDeletedEntities</span> |
| </td> |
| <td> <span class="datatype-reference">boolean |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">True iff deleted entities are excluded</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-excludeHeaderAttributes" class="property-name">excludeHeaderAttributes</span> |
| </td> |
| <td> <span class="datatype-reference">boolean |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-includeClassificationAttributes" class="property-name">includeClassificationAttributes</span> |
| </td> |
| <td> <span class="datatype-reference">boolean |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">True if classification attributes are included in search result.</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-includeSubClassifications" class="property-name">includeSubClassifications</span> |
| </td> |
| <td> <span class="datatype-reference">boolean |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">True iff sub-classifications are to be included</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-includeSubTypes" class="property-name">includeSubTypes</span> |
| </td> |
| <td> <span class="datatype-reference">boolean |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">True iff sub-type entities are to be included</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-limit" class="property-name">limit</span> |
| </td> |
| <td> <span class="datatype-reference">number |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">Max number of results to be returned</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-marker" class="property-name">marker</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">marker (offset of the next page)</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-offset" class="property-name">offset</span> |
| </td> |
| <td> <span class="datatype-reference">number |
| </span> |
| </td> |
| <td> <span class="property-constraints">required |
| </span> |
| </td> |
| <td> <span class="property-description">Offset(pagination) of the results</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-query" class="property-name">query</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">The type of query</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-relationshipFilters" class="property-name">relationshipFilters</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Relationship attribute filters for the relationship</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-relationshipName" class="property-name">relationshipName</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-sortBy" class="property-name">sortBy</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Attribute on which to sort the results</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-sortOrder" class="property-name">sortOrder</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_SortOrder.html">SortOrder</a> |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Sorting order of the results</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-tagFilters" class="property-name">tagFilters</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_FilterCriteria.html">FilterCriteria</a> |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Tag attribute filters for the classification/tag (if tag name is specified)</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-termName" class="property-name">termName</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">termName to search on</span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-typeName" class="property-name">typeName</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-constraints"> |
| </span> |
| </td> |
| <td> <span class="property-description">Type name to search on</span> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p class="lead">Example</p> |
| |
| <pre class="prettyprint language-js example">{ |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LT" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }</pre> |
| |
| <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> |
