Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

A Plataforma Carol disponibiliza duas formas de autenticação para uso de rotas privadas para Named Queries: OAuth2 e API Key. Mais detalhes acesse aqui.

03. PAGINAÇÃO

A Plataforma Carol disponibiliza  disponibiliza a opção do do page size / offset.

Para obter os 5 primeiros registros da primeira pagina utilizando o offset=0 e  e pageSize=5.



Para obter os 5 registros da segunda página, utilizando o offset=5 e  e pageSize=5.



Caso houvessem mais registros, seria possível utilizar o offset=10 e  e pageSize=5.

Também é possível retornar todos os dados em uma única única request. Isto não é recomendado pois a resposta pode ser lenta e podem haver limitação de quantidade de registros. Para tanto basta remover o campo campo offset e  e setar o campo pageSize=-1.


04. FILTROS

Por padrão, Named Queries retornam todos os dados dos Data Models (local onde os dados estão), mas é possível utilizar filtros para obter apenas os dados necessários. No caso abaixo os campos mdmpersonid e mdmname foram utilizados como filtro. Sempre lembrando que os campos do Data Model sempre estão dentro do objeto mdmGoldenFieldAndValues. A Plataforma Carol retorna outros campos que fazem parte da estrutura interna dela mas que não parecem fazer sentido para este caso.

...