Skip to main content

Guia de Uso: Endpoint de Listagem Paginada de Talentos

Funcionalidades Principaisā€‹

PaginaĆ§Ć£oā€‹

O endpoint suporta paginaĆ§Ć£o atravĆ©s do parĆ¢metro exclusiveStartKey. Quando vocĆŖ recebe uma resposta, ela inclui um valor exclusiveStartKey que vocĆŖ deve usar na prĆ³xima requisiĆ§Ć£o para obter a prĆ³xima pĆ”gina de resultados. Quando este valor for null, significa que vocĆŖ chegou ao final da lista.

OrdenaĆ§Ć£oā€‹

VocĆŖ pode ordenar os talentos por data de criaĆ§Ć£o (createdAt) ou data de atualizaĆ§Ć£o (updatedAt), em ordem crescente ou decrescente.

Filtragemā€‹

VocĆŖ pode filtrar talentos com base em uma data mĆ­nima de criaĆ§Ć£o ou atualizaĆ§Ć£o.

Formato de Dataā€‹

Todas as datas (updatedAt e createdAt) devem seguir o formato ISO 8601: YYYY-MM-DDTHH:mm:ss.sssZ. Por exemplo: 2025-04-15T10:30:00.000Z

Como Usarā€‹

Exemplo de RequisiĆ§Ć£oā€‹

{
  "orderBy": {
    "field": "updatedAt",
    "direction": "desc"
  },
  "filter": {
    "updatedAt": "2024-04-10T00:00:00.000Z"
  }
}

Esta requisiĆ§Ć£o retornarĆ” talentos atualizados apĆ³s 10 de abril de 2024, ordenados do mais recente para o mais antigo.

Exemplo de Respostaā€‹

{
  "items": [
    {
      "id": "123",
      "name": "JoĆ£o Silva",
      "email": "joao@exemplo.com",
      "updatedAt": "2024-04-15T10:30:00.000Z",
      "createdAt": "2024-03-20T08:15:00.000Z"
    },
    {
      "id": "456",
      "name": "Maria Santos",
      "email": "maria@exemplo.com",
      "updatedAt": "2024-04-12T14:45:00.000Z",
      "createdAt": "2024-02-05T11:20:00.000Z"
    }
  ],
  "exclusiveStartKey": {
    "tenantId": "empresa123",
    "updatedAt": "2024-04-12T14:45:00.000Z",
    "id": "456"
  },
  "orderBy": {
    "field": "updatedAt",
    "direction": "desc"
  },
  "filter": {
    "updatedAt": "2024-04-10T00:00:00.000Z"
  }
}

PaginaĆ§Ć£oā€‹

Para obter a prĆ³xima pĆ”gina, use o valor de exclusiveStartKey da resposta anterior:

{
  "exclusiveStartKey": {
    "tenantId": "empresa123",
    "updatedAt": "2024-04-12T14:45:00.000Z",
    "id": "456"
  },
  "orderBy": {
    "field": "updatedAt",
    "direction": "desc"
  },
  "filter": {
    "updatedAt": "2024-04-10T00:00:00.000Z"
  }
}

Regras Importantesā€‹

  1. Filtro e OrdenaĆ§Ć£o: Quando vocĆŖ usa filtro e ordenaĆ§Ć£o, ambos devem referenciar o mesmo campo (ou ambos createdAt ou ambos updatedAt).

  2. ConsistĆŖncia: Mantenha os mesmos parĆ¢metros de ordenaĆ§Ć£o e filtro ao navegar entre pĆ”ginas.

Exemplo de ImplementaĆ§Ć£oā€‹

Aqui estƔ um exemplo de como consumir o endpoint atƩ que todas as pƔginas sejam recuperadas:

async function listAllTalents() {
  const allTalents = [];
  let exclusiveStartKey = null;
  
  do {
    const response = await fetch('/talents/paginated', {
      method: 'POST',
      headers: {
        authorization: 'Bearer {{token}}',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        exclusiveStartKey,
        orderBy: {
          field: 'updatedAt',
          direction: 'desc'
        },
        filter: {
          updatedAt: '2024-04-10T00:00:00.000Z'
        }
      })
    });

    const data = await response.json();
    allTalents.push(...data.items);
    exclusiveStartKey = data.exclusiveStartKey;
  } while (exclusiveStartKey !== null);

  return allTalents;
}