Reacties filteren in de Reactor-API

Last update: Wed May 24 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Tags

Gemaakt voor:

Developer

Wanneer u eindpunten van lijsten (GET) gebruikt in de Reactor-API, is het mogelijk dat u de geretourneerde resultaten moet beperken tot een subset van records. Hiervoor ondersteunen veel van de eindpunten van de lijst van de API de mogelijkheid om te filteren op specifieke kenmerken. Als u gestructureerde vragen aan API in plaats daarvan wilt maken, zie de gids op zoeken.

Filtersyntaxis

In het volgende voorbeeld wordt uitgelegd hoe u filters voor uw GET-aanvragen kunt implementeren.

API-indeling

Om de reactie voor een bepaald lijsteindpunt te filtreren, moet u a leveren filter queryparameter in het aanvraagpad.

NOTE

De onderstaande sjabloon gebruikt vierkant haakje ([]) en spatietekens voor leesbaarheid. In de praktijk moeten deze tekens URI-gecodeerd zijn, zoals in RFC 3986. Deze handleiding bevat een voorbeeld van een correct gecodeerd aanvraagpad.

Als de structuur van de filters onjuist is, worden geen filters toegepast en wordt de volledige resultaatset geretourneerd.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME}]={OPERATOR} {VALUE}

Eigenschap

Beschrijving

{ENDPOINT}

Een eindpunt in de Reactor-API dat filterparameters ondersteunt.

{ATTRIBUTE_NAME}

De naam van een specifiek kenmerk waarop filterresultaten moeten worden uitgevoerd. Houd er rekening mee dat verschillende eindpunten verschillende kenmerken voor filteren ondersteunen. Verwijs naar de verwijzingsgids voor het eindpunt u met voor een lijst van beschikbare het filtreren attributen werkt.

{OPERATOR}

De exploitant die bepaalt hoe de resultaten tegen verstrekte {VALUE}. Ondersteunde operatoren worden vermeld in de aanhangsel.

{VALUE}

De waarde waarmee de geretourneerde resultaten moeten worden vergeleken. Bij vergelijking voor gelijkheid met de EQ -operator, moet de waarde een exacte, hoofdlettergevoelige overeenkomst zijn om in de reactie te worden opgenomen.

Verzoek

In de onderstaande voorbeeldaanvraag wordt een lijst met gepubliceerde bibliotheken opgehaald door een filter toe te passen waarvoor de bibliotheek nodig is state kenmerk gelijk published.

Voordat URI-codering wordt uitgevoerd, ziet de syntaxis voor dit filter in het aanvraagpad er ongeveer als volgt uit:

https://reactor.adobe.io/properties/PR906238a59bbf4262bcedba248f483600/libraries?filter[state]=EQ published

Zodra de weg en vraagparameters URI-gecodeerd zijn, kunnen zij in API verzoeken zoals hieronder worden gebruikt:

curl -X GET \
  https://reactor.adobe.io/properties/PR906238a59bbf4262bcedba248f483600/libraries?filter%5Bstate%5D=EQ%20published \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Filteren op meerdere waarden multiple-values

Als u met meerdere waarden voor één kenmerk wilt filteren, geeft u de waarden op als een lijst met door komma's gescheiden waarden.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME}]={OPERATOR} {VALUE_1},{VALUE_2}

Meerdere filters gebruiken

Als u filters wilt toepassen op meerdere kenmerken, voert u een filter parameter voor elk kenmerk. Parameters moeten door ampersand worden gescheiden (&) tekens.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME_1}]={OPERATOR} {VALUE}&filter[{ATTRIBUTE_NAME_2}]={OPERATOR} {VALUE}

NOTE

Als u hetzelfde kenmerk in meerdere filters opgeeft op dezelfde aanvraag, wordt alleen het laatst opgegeven filter voor dat kenmerk toegepast.

Aanhangsel

De volgende sectie bevat aanvullende informatie voor het werken met filters in de Reactor-API.

Ondersteunde filteroperatoren operators

In de volgende tabel worden de ondersteunde operatorwaarden voor filterparameters weergegeven. Houd er rekening mee dat, afhankelijk van het kenmerk waarop u filtert, niet alle beschikbare filteroperatoren van toepassing zijn, zoals het gebruik van de operatoren "kleiner dan" of "groter dan" voor tekenreekskenmerken.

Operator

Beschrijving

EQ

Het kenmerk moet gelijk zijn aan de opgegeven waarde.

NOT

Het kenmerk mag niet gelijk zijn aan de opgegeven waarde.

LT

Het kenmerk moet kleiner zijn dan de opgegeven waarde.

GT

Het kenmerk moet groter zijn dan de opgegeven waarde.

BETWEEN

Het kenmerk moet binnen een opgegeven waardenbereik vallen. Wanneer u deze operator gebruikt, twee waarden moeten worden verstrekt om de minimum- en maximumwaarden voor het gewenste bereik aan te geven.

CONTAINS

Het kenmerk moet de opgegeven waarde bevatten, zoals een set tekens binnen een tekenreekskenmerk.

recommendation-more-help

12b4e4a9-5028-4d88-8ce6-64a580811743