SearchParameters Data Type

Properties
name data type constraints description
attributes array of string  
classification string  
entityFilters FilterCriteria  
excludeDeletedEntities boolean required
excludeHeaderAttributes boolean required
includeClassificationAttributes boolean required
includeSubClassifications boolean required
includeSubTypes boolean required
limit number required
marker string  
offset number required
query string  
relationshipFilters FilterCriteria  
relationshipName string  
sortBy string  
sortOrder SortOrder  
tagFilters FilterCriteria  
termName string  
typeName string  

Example

{
  "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" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "TIME_RANGE"
  },
  "relationshipName" : "...",
  "sortBy" : "...",
  "sortOrder" : "DESCENDING",
  "tagFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "LIKE"
  },
  "termName" : "...",
  "typeName" : "..."
}