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
Params
None
Filter Operations Table
Name | Description | Cells API | Rows API |
---|---|---|---|
Equals | Exact value | 0 | $eq |
Contains | String search | 1 | $contains |
Greater | Number or date comparison | 2 | $gt |
GreaterOrEqual | Number or date comparison | 3 | $gte |
Less | Number or date comparison | 4 | $lt |
LessOrEqual | Number or date comparison | 5 | $lte |
StartsWith | String comparison | 6 | $startswith |
In | Array comparison of id | 7 | $in |
Between | Number or date comparison | 8 | $between |
NotIn | Value is not in an array of values | 9 | $nin |
NotEqualTo | Value is not equal to x | 10 | $not |
DoesntContain | String comparison for missing value | 11 | -- |
NoData | Value is null | 12 | -- |
NotNoData | Value is not null | 13 | -- |
EndsWith | String comparison | -- | $endswith |
Or | Either or comparison | -- | $or |
And | And 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
}
]