Filtrar respostas na API do reator

Última atualização em 2023-03-14
  • Tópicos
  • Tags
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

Ao usar endpoints de lista (GET) na API do Reactor, talvez você precise limitar os resultados retornados a um subconjunto de registros. Para isso, muitos dos endpoints de lista da API dão suporte à capacidade de filtrar por atributos específicos. Se, em vez disso, você quiser fazer consultas estruturadas à API, consulte o manual sobre pesquisa.

Sintaxe de filtragem

O exemplo a seguir explica como implementar filtros para solicitações GET.

Formato da API

Para filtrar a resposta de um endpoint de lista específico, você deve fornecer um parâmetro de consulta filter no caminho da solicitação.

OBSERVAÇÃO

O modelo abaixo usa colchetes ([]) e caracteres de espaço para facilitar a leitura. Na prática, esses caracteres devem ser codificados por URI, conforme descrito na RFC 3986. Um exemplo de um caminho de solicitação corretamente codificado é mostrado posteriormente neste manual.

Observe que se a estrutura dos filtros estiver incorreta, nenhum filtro será aplicado e o conjunto de resultados completo será retornado.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME}]={OPERATOR} {VALUE}
Propriedade Descrição
{ENDPOINT} Um ponto de extremidade da listagem na API do Reactor compatível com parâmetros de filtro.
{ATTRIBUTE_NAME} O nome de um atributo específico pelo qual filtrar resultados. Lembre-se de que diferentes pontos de extremidade são compatíveis com atributos diferentes para filtragem. Consulte o guia de referência do endpoint com o qual você está trabalhando para obter uma lista de atributos de filtragem disponíveis.
{OPERATOR} O operador que determina como os resultados são avaliados em relação ao {VALUE} fornecido. Os operadores compatíveis estão listados na seção Apêndice.
{VALUE} O valor para comparar os resultados retornados. Quando você compara para determinar a igualdade usando o operador EQ, o valor deve ser uma correspondência exata, que diferencia maiúsculas e minúsculas, para ser incluído na resposta.

Solicitação

A solicitação de exemplo abaixo recupera uma lista de bibliotecas publicadas aplicando um filtro que exige o atributo state da biblioteca para ser igual a published.

Antes da codificação do URI, a sintaxe desse filtro no caminho da solicitação seria semelhante ao seguinte:

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

Depois que os parâmetros de caminho e consulta tiverem sido codificados por URI, eles poderão ser usados em solicitações de API, como a seguir:

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}'

Filtragem em vários valores

Para filtrar por vários valores para um único atributo, forneça os valores como uma lista separada por vírgulas.

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

Utilização de vários filtros

Para aplicar filtros para vários atributos, forneça um parâmetro filter para cada atributo. Os parâmetros devem ser separados por caracteres de E comercial (&).

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME_1}]={OPERATOR} {VALUE}&filter[{ATTRIBUTE_NAME_2}]={OPERATOR} {VALUE}
OBSERVAÇÃO

Se você especificar o mesmo atributo em vários filtros na mesma solicitação, somente o último filtro fornecido para esse atributo será aplicado.

Apêndice

A seção a seguir contém informações adicionais para trabalhar com filtros na API do reator.

Operadores de filtro compatíveis

A tabela a seguir lista os valores de operador compatíveis com os parâmetros de filtro. Lembre-se de que, dependendo do atributo que você está filtrando, nem todos os operadores de filtro disponíveis serão aplicáveis, como o uso de operadores "menor que" ou "maior que" para atributos de string.

Operador Descrição
EQ O atributo deve ser igual ao valor fornecido.
NOT O atributo não deve ser igual ao valor fornecido.
LT O atributo deve ser menor que o valor fornecido.
GT O atributo deve ser maior que o valor fornecido.
BETWEEN O atributo deve estar dentro de um intervalo de valores especificado. Quando você usa esse operador, dois valores devem ser fornecidos a fim de indicar os valores mínimo e máximo para o intervalo desejado.
CONTAINS O atributo deve conter o valor fornecido, como um conjunto de caracteres em um atributo de string.
Página anterior
Next page

Nesta página