Histórico da Página
Sumário
...
Índice | ||
---|---|---|
|
Objetivo
...
Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.
1 - Métodos
...
A API de JobExecution possui apenas o método GET implementado. É possível utilizar os filtros padrões da API para filtrar um registro desejado, ou utilizar a assinatura /jobExecution/{executionId} para retornar um executionId específico.
...
Informações | ||||
---|---|---|---|---|
| ||||
A Api de JobExecution também realiza buscas pelo status do agendamento, são eles:
|
1.1 - GET
...
1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)
...
Informações | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
1.1.2 - Order(Resultado Ordenado)
Informações | ||
---|---|---|
| ||
Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos). Exemplo 1: ?order=campo1 (Ascendente) Exemplo 2: ?order=-campo1 (Descendente) Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ... |
...
Informações | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
1.1.3 - Filter (Resultado filtrado)
...
Informações | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
1.1.4 - Paginação
...
Informações | ||
---|---|---|
| ||
Page: Página que será apresentada. PageSize: Quantidade máxima de registros por página que serão apresentados. Exemplo: ?page=valor1&pageSize=1 Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão. Page: 1 PageSize: 20 |
Informações | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
1.1.5 - Fields (Retorno de campos específicos no resultado)
...
Informações | ||
---|---|---|
| ||
Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado. Exemplo: ?fields=campo1 Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ... |
Informações | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
1.1.6 - GetOne (Recuperar a execução pelo executionId)
...
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|