Who is this article for?

Users who need to search records that meet a variety of requirements and assist with populating data repositories

Restricted access to Users with interface development roles. It is a read-only HTTP/JSON API.

Search API allows for two distinct types of query conditions: compound conditions and simple conditions. Both types adhere to a consistent formatting structure, ensuring clarity and uniformity when constructing queries. 

A compound condition is characterized by its inclusion of multiple simple conditions. This allows for a more complex query that can evaluate several criteria simultaneously. For instance, if you are searching for records that meet a variety of requirements, a compound condition enables you to combine these simple conditions into a cohesive query. 

Simple conditions are standalone and cannot incorporate compound conditions within them. 

This distinction is crucial for users to understand how to effectively utilize the Search API and construct precise queries that yield the desired results.

Compound Conditions

Compound conditions have three parameters. condition, query and not. These are conditions that will check multiple simple conditions to return the desired data. These are either an "AND" or an "OR" condition. These conditions will contain a list of query conditions to match against.

{
  "query": {
    "condition": "AND",
    "query": [
      {
        "condition": "equals",
        "field": "fieldA",
        "term": [
          "matchMe"
        ]
      },
      {
        "condition": "equals",
        "field": "fieldB",
        "term": [
          "matchMeToo"
        ]
      }
    ]
  }
}

Simple Conditions

Simple conditions control what type of "conditions" must be met for the data to be returned. Not all conditions will require all parameters to be set, and not all parameters are required.

//find all that have "matchMe" for the value in "fieldA"
{
  "query": {
    "condition": "equals",
    "field": "fieldA",
    "term": [
      "matchMe"
    ]
  }
}

//find all that have a version between 1 and 10
{
  "query": {
    "condition": "between",
    "field": "version",
    "term": [
      1,
      10
    ]
  }
}

//find all that have a date in today's date
{
  "query": {
    "condition": "today",
    "field": "date"
  }
}

//find where the assigned field is empty or missing
{
  "query": {
    "condition": "empty",
    "field": "_assigned"
  }
}

Available Conditions

key:
term(#) = the number of expected term values.
term(S) = can have any number of terms to match against.

Query Types