Paginering en filtering
De meeste list-endpoints accepteren standaard query parameters voor paginering, sorting en filtering.
Paginering
Section titled “Paginering”GET /v2/alarms?offset=0&limit=20&includeTotal=trueoffset is zero-based. limit default naar 20 en heeft een maximum van 100 in het schema. includeTotal vraagt een total count wanneer beschikbaar.
Sorteren
Section titled “Sorteren”Sort gebruikt JSON:API stijl en kan herhaald worden om meerdere velden door te geven.
Sorteer op meerdere velden
Section titled “Sorteer op meerdere velden”GET /v2/alarms?sort=name&sort=-createdAtSorteer met stabiele tie-breakers
Section titled “Sorteer met stabiele tie-breakers”GET /v2/alarms?sort=-priority&sort=-createdAt&sort=idSorteer op gerelateerde velden
Section titled “Sorteer op gerelateerde velden”GET /v2/groups?sort=organization.name&sort=-createdAtIncludes
Section titled “Includes”Gebruik include en fields om relaties of veldselecties op te vragen.
Include relaties
Section titled “Include relaties”GET /v2/alarms?include=group&include=ownerBeperk responsevelden
Section titled “Beperk responsevelden”GET /v2/alarms?fields=id&fields=status&fields=createdAtInclude gerelateerde data met beperkte velden
Section titled “Include gerelateerde data met beperkte velden”GET /v2/users?include=profile&fields=id&fields=firstName&fields=lastName&fields=emailFilteren
Section titled “Filteren”Gebruik filter[field][operator]=value. Operators zijn eq, ne, gt, gte, lt, lte, like, in, notIn, between, notBetween, startsWith, endsWith, en substring.
Filter op datumbereik
Section titled “Filter op datumbereik”GET /v2/alarms?filter[status][eq]=started&filter[createdAt][between]=2024-01-01&filter[createdAt][between]=2024-12-31Gebruik meerdere filters op verschillende velden
Section titled “Gebruik meerdere filters op verschillende velden”GET /v2/users?filter[status][eq]=active&filter[role][notIn]=Guest&filter[email][like]=%@example.comFilter operators
Section titled “Filter operators”| Operator | Betekenis | Voorbeeld |
|---|---|---|
eq | Gelijk aan waarde. | filter[status][eq]=started |
ne | Niet gelijk aan waarde. | filter[status][ne]=stopped |
gt | Groter dan. | filter[priority][gt]=3 |
gte | Groter dan of gelijk aan. | filter[priority][gte]=3 |
lt | Kleiner dan. | filter[priority][lt]=3 |
lte | Kleiner dan of gelijk aan. | filter[priority][lte]=3 |
like | SQL LIKE patroon. | filter[name][like]=%acme% |
startsWith | Begint met waarde. | filter[name][startsWith]=Acme |
endsWith | Eindigt met waarde. | filter[name][endsWith]=Inc |
substring | Bevat substring. | filter[name][substring]=care |
in | In lijst van waarden. | filter[role][in]=Admin&filter[role][in]=User |
notIn | Niet in lijst van waarden. | filter[role][notIn]=Guest |
between | Tussen twee waarden. | filter[createdAt][between]=2024-01-01&filter[createdAt][between]=2024-12-31 |
notBetween | Niet tussen twee waarden. | filter[createdAt][notBetween]=2024-01-01&filter[createdAt][notBetween]=2024-12-31 |
Geavanceerde voorbeelden
Section titled “Geavanceerde voorbeelden”Combineer filters met paginering en sorting
Section titled “Combineer filters met paginering en sorting”GET /v2/alarms?offset=40&limit=20&sort=-createdAt&filter[status][eq]=started&filter[trigger][in]=app&filter[trigger][in]=buttonFilter op datumbereik en include totals
Section titled “Filter op datumbereik en include totals”GET /v2/alarms?includeTotal=true&filter[createdAt][between]=2024-01-01&filter[createdAt][between]=2024-12-31Combineer includes, fields en filters
Section titled “Combineer includes, fields en filters”GET /v2/groups?include=organization&fields=name&fields=status&filter[status][eq]=activeCombineer sorting met include en fields
Section titled “Combineer sorting met include en fields”GET /v2/organizations?include=owner&fields=id&fields=name&fields=createdAt&sort=-createdAtCombineer nested includes met related-field sorting
Section titled “Combineer nested includes met related-field sorting”GET /v2/groups?include=organization.owner&sort=organization.name&sort=-createdAtResponse metadata
Section titled “Response metadata”List responses bevatten paging metadata zoals offset, limit, length, hasMore, en optioneel total, warnings, en errors.