Tempo aproximado para leitura: 00:03:06min
Dúvida
Como utilizar filtro padrão ODATA no consumo API?
Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.
Solução
1. As APIs expostas no RM.Host, suportam filtros no padrão ODATA. A seguir, serão mostrados alguns exemplos de utilização:
| Operador | Descrição | Exemplo |
| Logical Operators | ||
| eq | Equal | /Suppliers?$filter=Address/City eq 'Redmond' |
| ne | Not equal | /Suppliers?$filter=Address/City ne 'London' |
| gt | Greater than | /Products?$filter=Price gt 20 |
| ge | Greater than or equal | /Products?$filter=Price ge 10 |
| lt | Less than | /Products?$filter=Price lt 20 |
| le | Less than or equal | /Products?$filter=Price le 100 |
| and | Logical and | /Products?$filter=Price le 200 and Price gt 3.5 |
| or | Logical or | /Products?$filter=Price le 3.5 or Price gt 200 |
| not | Logical negation | /Products?$filter=not endswith(Description,'milk') |
| Grouping Operators | ||
| ( ) | grouping | /Products?$filter=(Price lt 5) |
Ao utilizar campos do tipo data é importante saber:
- Datas devem ser informadas com Time Zone. Exemplo: 2014-07-07T18:32:15Z ou 2014-07-07T15:32:15-03:00
- Datas enviadas na requisição entre aspas, por exemplo: "2014-07-07T15:32:15-03:00", serão tratadas internamente como string. Recomenda-se usar o Time Zone.
2. Aplicação do filtro:
Para contextualizar o uso dos filtros, utilizamos a API de usuários como exemplo.
Para filtrar todos os usuários que tem a data de criação igual a "2014-07-07T18:32:15Z", a seguinte requisição será feita:
http://localhost:8051/api/framework/v1/users?$filter=(meta.created eq 2014-07-07T18:32:15Z)
Saiba Mais
Utilizando filtros complexos
0 Comentários