Skip to main content

Introdução

Compreendendo os dados de exemplo que usaremos nos capítulos​

IMPORTANTE

Inicialmente, apresentaremos os modelos de dados que serão utilizados pelas queries que serão mostradas nos capítulos seguintes.

Modelo de Dados: Student

Dados: Student

Modelo de dados: Registry

Dados: Registry

API/Endpoint​

O endpoint a ser utilizado para consultar dados é POST /api/v2/queries/filter:

Os parâmetros estão descritos abaixo:

Paginação (Query Parameters)​

  • offset: Posição do registro a partir da qual começar a obter resultados.
  • pageSize: Número de registros a obter (limitado a 1000).
  • sortBy: Campo para ordenar as informações (Ex: mdmGoldenFieldAndValues.name, sortBy name).
  • sortOrder: Caso sortBy seja usado, a ordem a considerar (Valores: ASC ou DESC).
  • indexType: Índice de onde consultar os dados (STAGING/MASTER).
  • fields: Campos retornados na resposta.
  • tags: Filtrar por tag do Data Model.
  • body: Json Request

Payload (JSON)​

  • mustList: Lista de filtros que DEVEM ser verdadeiros para retornar o registro (É o mesmo que AND no SQL).
  • mustNotList: Lista de filtros que NÃO DEVEM ser verdadeiros para retornar o registro (É o mesmo que NOT no SQL).
  • shouldList: Lista de filtros que PODEM ser verdadeiros para retornar o registro (É o mesmo que OR no SQL).
  • minimumShouldMatch: Número de filtros should que devem corresponder para serem retornados.
  • aggregationList: Agregações/resumos para obter o resultado.

No próximo capítulo​

Aprenda como construir filtros com estes dados de exemplo clicando ➡️ Filtros.