Cross Segmentos - Backoffice RM - Integração - API - Consumo API JobExecution – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:04:00 min

Dúvida
Como consumir a API de JobExecution.

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.

Solução
Este documento tem o objetivo exemplificar o uso da API de JobExecution, a fim de utilizar todos os métodos implementados.

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.

O executionId é composto por duas chaves: "jobScheduleID|execution".
Por exemplo: executionId = "200047|3", esta é a chave para retornar a terceira execução do Job 200047.

Observação:

A Api de JobExecution também realiza buscas pelo status do agendamento, são eles:

Success
Pending
Running
Failure

1.1 - Get All (Recuperar todas as execuções de jobs realizados na base)

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution

Exemplo de Resultado

{

"hasNext": true,
"items": [
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008 17:16:05",
"user": "",
"return": ""
},
{
"executionId": "100002|1",
"jobScheduleId": "100002",
"status": "success",
"createdDate": "",
"startedDate": "25/11/2008 15:39:21",
"user": "",
"return": ""
}]}

1.2 - Order (Resultado Ordenado)

Parâmetros

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 ...

1.2 Order (Asc)

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution?order=[-]{campo}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleId

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?order=jobScheduleId

Exemplo de Resultado

{

1.2 Order (Desc)

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution?order=[-]{campo}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleId

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?order=-jobScheduleId

Exemplo de Resultado

{

"hasNext": true,
"items": [
{
"executionId": "102789|1",
"jobScheduleId": "102789",
"status": "success",
"createdDate": "05/10/2018 10:05:20",
"startedDate": "05/10/2018 10:05:22",
"user": "rm",
"return": ""
},
{
"executionId": "102788|1",
"jobScheduleId": "102788",
"status": "success",
"createdDate": "05/10/2018 09:55:30",
"startedDate": "05/10/2018 09:55:30",
"user": "mestre",
"return": ""
}]}

1.3 - Filter (Resultado Filtrado)

1.3 Filter

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution?{campo}={valor}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: success

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?status=success

Exemplo de Resultado

{

1.4 - Paginação

Parâmetros

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

1.4 Paginacao

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution?page={valor1}&pageSize={valor2}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?page=1&pageSize=1

Exemplo de Resultado

{

"hasNext": true,
"items": [
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008 17:16:05",
"user": "",
"return": ""
}]}

1.5 - Fields (Retorno de campos específicos no resultado)

Parâmetros

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 ...

1.5 Fields

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution?fields={campo}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: status,jobScheduleId,executionId

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?fields=status,jobScheduleId,executionId

Exemplo de Resultado

{

"hasNext": true,
"items": [
{
"executionId": "100360|866",
"jobScheduleId": "100360",
"status": "pending"
},
{
"executionId": "100362|682",
"jobScheduleId": "100362",
"status": "pending"
}]}

1.6 - GetOne (Recuperar a execução pelo executionId)

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobExecution/{executionId}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

executionId: 100025|3 , onde jobScheduleId = 100025 e o número da execução = 3

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution/100025|3

Exemplo de Resultado

{
"executionId": "100025|3",
"jobScheduleId": "100025",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 11:58:29",
"user": "",
"return": ""
}

Saiba Mais
Segue abaixo documentação do JobExecution:
API de JobExecution

Olá,

Cross Segmentos - Backoffice RM - Integração - API - Consumo API JobExecution

0 Comentários

Olá ,

Olá ,

Olá ,

Olá,