SearchParameters Data Type

Properties
name data type constraints description
attributes array of string   Attribute values included in the results
classification string   Classification/tag to search on
entityFilters FilterCriteria   Entity attribute filters for the type (if type name is specified)
excludeDeletedEntities boolean required True iff deleted entities are excluded
excludeHeaderAttributes boolean required
includeClassificationAttributes boolean required True if classification attributes are included in search result.
includeSubClassifications boolean required True iff sub-classifications are to be included
includeSubTypes boolean required True iff sub-type entities are to be included
limit number required Max number of results to be returned
marker string   marker (offset of the next page)
offset number required Offset(pagination) of the results
query string   The type of query
relationshipFilters FilterCriteria   Relationship attribute filters for the relationship
relationshipName string  
sortBy string   Attribute on which to sort the results
sortOrder SortOrder   Sorting order of the results
tagFilters FilterCriteria   Tag attribute filters for the classification/tag (if tag name is specified)
termName string   termName to search on
typeName string   Type name to search on

Example

{
  "attributes" : [ "...", "..." ],
  "classification" : "...",
  "entityFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "CONTAINS_ALL"
  },
  "excludeDeletedEntities" : true,
  "excludeHeaderAttributes" : true,
  "includeClassificationAttributes" : true,
  "includeSubClassifications" : true,
  "includeSubTypes" : true,
  "limit" : 12345,
  "marker" : "...",
  "offset" : 12345,
  "query" : "...",
  "relationshipFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "AND",
    "criterion" : [ { }, { } ],
    "operator" : "NEQ"
  },
  "relationshipName" : "...",
  "sortBy" : "...",
  "sortOrder" : "ASCENDING",
  "tagFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "TIME_RANGE"
  },
  "termName" : "...",
  "typeName" : "..."
}