このページは、まだ日本語ではご利用いただけません。翻訳中です。
Filtering
The Konnect APIs support the ability to filter over selected collections and only return results that you are interested in. This reference document explains how filtering generally works across Konnect APIs.
Not every filter operation described here is available in every Konnect API. Specific APIs may support a subset of these options. For the most accurate information on available filters for each API endpoint, always refer to the individual API specification.
Available fields
-
Users:
id
,email
,full_name
,active
-
Teams:
id
,name
,system_team
-
Assigned Roles:
role
,entity_type
,entity_region
,entity_id
Numeric and timestamp fields
When matching against both numeric and timestamp fields, you can filter in the following formats:
-
Equal:
?filter[field][eq]=value
or?filter[field]=value
-
Contains:
?filter[field][contains]=value
-
Less Than:
?filter[field][lt]=value
-
Less Than or Equal:
?filter[field][lte]=value
-
Greater Than:
?filter[field][gt]=value
-
Greater Than or Equal:
?filter[field][gte]=value
If the qualifier is omitted, ?filter[field]=value
for example, the filtering behavior will perform an exact style
equal match.
Examples
Given a response schema of:
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "CharlieCruz@konghq.com",
"name": "Charlie",
"full_name": "Charlie Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z"
},
{
"id": "500d74f4-37e1-4b13-b51a-8cf7c7903692",
"email": "AlexCruz@konghq.com",
"name": "Alex",
"full_name": "Alex Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z",
"updated_at": "2022-10-19T15:33:02Z"
},
{
"id": "500d74f4-37e1-4d13-b51a-8cf7c7903692",
"email": "AlexGarcia@konghq.com",
"name": "Alex",
"full_name": "Alex Garcia",
"active": true,
"created_at": "2022-05-10T15:10:25Z",
"updated_at": "2022-10-19T15:33:02Z"
}
]
}
Single Filter
With a single filter parameter, ?filter[name][contains]=Charlie
, the expected
results are:
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "CharlieCruz@konghq.com",
"name": "Charlie",
"full_name": "Charlie Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z"
}
]
}
A single filter parameter can return multiple results. Using ?filter[name][contains]=Cruz
,
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "CharlieCruz@konghq.com",
"name": "Charlie",
"full_name": "Charlie Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z"
},
{
"id": "500d74f4-37e1-4b13-b51a-8cf7c7903692",
"email": "AlexCruz@konghq.com",
"name": "Alex",
"full_name": "Alex Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z",
"updated_at": "2022-10-19T15:33:02Z"
}
]
}
With a single filter parameter, ?filter[full_name]=Charlie%20Cruz
, the expected
results are the same:
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "CharlieCruz@konghq.com",
"name": "Charlie",
"full_name": "Charlie Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z"
}
]
}
Multiple Filters
With multiple filter parameters,
?filter[name][contains]=Cruz&filter[full_name]=Alex%Cruz
, the expected
results are:
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "AlexCruz@konghq.com",
"name": "Alex",
"full_name": "Alex Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z",
"updated_at": "2022-10-19T15:33:02Z"
}
]
}
Key Existence Filter
To verify a key in the schema is present, you can provide the following
filter parameters, ?filter[updated_at]&filter[full_name][contains]=Cruz
. The
expected results are:
{
"data": [
{
"id": "500d74f4-37e1-4f59-b51a-8cf7c7903692",
"email": "AlexCruz@konghq.com",
"name": "Alex",
"full_name": "Alex Cruz",
"active": true,
"created_at": "2022-05-10T15:10:25Z",
"updated_at": "2022-10-19T15:33:02Z"
}
]
}