GET Filter Operations

Filter Operations

Returns all filter operations supported by the Data APIs. See the Filter Operations Table below to identify the correct operator to use for a given filter operation for both the Cells API and the Rows API

Swagger

Filter Operations

Params

None

Filter Operations Table

NameDescriptionCells APIRows API
EqualsExact value0$eq
ContainsString search1$contains
GreaterNumber or date comparison2$gt
GreaterOrEqualNumber or date comparison3$gte
LessNumber or date comparison4$lt
LessOrEqualNumber or date comparison5$lte
StartsWithString comparison6$startswith
InArray comparison of id7$in
BetweenNumber or date comparison8$between
NotInValue is not in an array of values9$nin
NotEqualToValue is not equal to x10$not
DoesntContainString comparison for missing value11--
NoDataValue is null12--
NotNoDataValue is not null13--
EndsWithString comparison--$endswith
OrEither or comparison--$or
AndAnd comparison--$and

Request

GET {{host}}/api/rest/v4/schema/filteroperations
Authorization: {{auth}}

Response

[
  {
    "id": 0,
    "name": "Equals",
    "entryListId": 0
  },
  {
    "id": 1,
    "name": "Contains",
    "entryListId": 0
  },
  {
    "id": 2,
    "name": "Greater",
    "entryListId": 0
  },
  {
    "id": 3,
    "name": "GreaterOrEqual",
    "entryListId": 0
  },
  {
    "id": 4,
    "name": "Less",
    "entryListId": 0
  },
  {
    "id": 5,
    "name": "LessOrEqual",
    "entryListId": 0
  },
  {
    "id": 6,
    "name": "StartsWith",
    "entryListId": 0
  },
  {
    "id": 7,
    "name": "In",
    "entryListId": 0
  },
  {
    "id": 8,
    "name": "Between",
    "entryListId": 0
  },
  {
    "id": 9,
    "name": "NotIn",
    "entryListId": 0
  },
  {
    "id": 10,
    "name": "NotEqualTo",
    "entryListId": 0
  },
  {
    "id": 11,
    "name": "DoesntContain",
    "entryListId": 0
  },
  {
    "id": 12,
    "name": "NoData",
    "entryListId": 0
  },
  {
    "id": 13,
    "name": "NotNoData",
    "entryListId": 0
  }
]