Conceito: paginação de resultados da consulta de WQL
Quando você executa uma consulta pela primeira vez, a Workday Query Language (WQL) no parâmetro de consulta é executada e cria um cache que retorna no máximo 10.000 linhas. Você pode acessar linhas adicionais paginando o conjunto de resultados usando o
limit
e offset
na chamada API REST para sua consulta WQL.O WQL armazena em cache as solicitações de limitação de página apenas para a duração de uma sessão de usuário.
Para visualizar os resultados restantes, use estes parâmetros:
Parâmetro | Descrição |
|---|---|
limit
| Especifica o número de linhas em uma página de resultados. Os valores devem estar entre 0 e 10.000. |
offset
| Especifica a linha inicial do conjunto de resultados. Usada por limit parâmetro
Na solicitação inicial da primeira página de resultados, omita o offset parâmetro ou defina-o como zero. |
O Workday reserva a palavra-chave
LIMIT
para uma cláusula e um parâmetro de paginação. A palavra-chave LIMIT não diferencia maiúsculas de minúsculas. Usamos maiúsculas e minúsculas para ajudar a diferenciar entre cláusulas e parâmetros de paginação.
- Use oLIMITpara limitar o número total de linhas retornadas em uma resposta da consulta.
- Use olimitO parâmetro para especificar quantas linhas serão exibidas por página de resposta à consulta.
Exemplos
Dependendo de onde você faz solicitações WQL, o URL base que você usa é diferente.
Origem da solicitação de WQL
| URL base a ser usado
|
|---|---|
Anfitrião definido pelo locatário do Workday | https://{hostname}/api/wql/{version}/{tenant}
|
Gateway de API do WCP | https://api.workday.com/wql/{version}
|
Para retornar 1.000 linhas começando com a primeira linha do conjunto de resultados:
{baseURL}/data?limit=1000&offset=0&query=select worker, location from allWorkers
Para retornar as próximas 1.000 linhas, aumente o deslocamento para 1.000:
{baseURL}/data?limit=1000&offset=1000&query=select worker, location from allWorkers