Query conditions

All queries can be constrained by arbitrary fields defined in the DataView. A series of condition objects can be included in the request for any egress endpoint. Each condition object contains the field to constrain, an operator, and a value to compare.

Operators

The following operators are allowed:

Condition objects

Condition objects should follow the following structure:

{
  "conditions": [
    {
      "field": "name",
      "operator": "=", 
      "value": "alice"
    }
  ]
}

Working with arrays

In order to detect a single value inside an array type DataField use the contains operator.

{
  "conditions": [
    {
      "field": "titles",
      "operator": "contains", 
      "value": "alice"
    }
  ]
}

An array can also be used as a value to test each element against a non-array data type. This functionality happens automatically when the equality operator is used as a value.

{
  "conditions": [
    {
      "field": "name",
      "operator": "=", 
      "value": ["alice", "bob", "charles"]
    }
  ]
}