Apêndice 3: Filtros

Em diversas chamadas da API, é possível enviar filtros para o Módulo Risk Manager e só receber as informações compatíveis com os filtros aplicados. Cada chamada da API possui um conjunto específico de filtros para cada propriedade e atributos.

Nas chamadas que aceitam filtros, os campos suportados são apresentados na seção "CAMPOS SUPORTADOS PELO FILTRO". Observe que, em alguns casos, os objetos também podem ser filtrados pelos seus atributos customizados.

Os filtros seguem o padrão ODATA (http:/www.odata.org/documentation/odata-version-2-0/uri-conventions).

Este apêndice apresenta os tipos de filtros suportados pela API para cada tipo de dados: guid; string (ou text); byte (ou int); double (ou float); e datetime.

 

Os operadores suportados nas expressões estão descritos na tabela abaixo:

Operador

Descrição

Exemplo

and

E lógico

Relevance eq 5 and Criticality eq 5

or

Ou lógico

Relevance eq 5 or Criticality eq 5

(  )

Agrupamento precedente

(Relevance eq 5 and Criticality eq 5) or (AnalysisFrequency eq 5)

 

LIMITAÇÕES CONHECIDAS

    Os parâmetros $select e $expand do padrão ODATA não foram implementados.

    Para utilizar caracteres especiais como "&" e aspas simples, são necessários tratamentos especiais. Exemplos:

Para fazer um filtro que contenha "McDonald's" no campo "Description", é necessário duplicar a aspa de "McDonald's"” como no exemplo a seguir: substringof(' McDonald''s ',Description).

Para fazer um filtro que contenha "Johnson&Johnson" no campo "Description", é necessário substituir o & pela sua codificação hexadecimal, nesse caso %26. Exemplo: substringof(Johnson%26Johnson',Description).