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

Tempo aproximado para leitura: 00:05:00 min

Dúvida
Como consumir a API de JobScheduler.

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

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

Serão apresentados 4 métodos, os quais foram implementados na API de JobScheduler. São eles:

1.1 - GET
1.1.1 - Get All (Recuperar Todos os Agendamentos de Job)
1.1.2 - Order(Resultado Ordenado)
1.1.3 - Filter (Resultado filtrado)
1.1.4 - Paginação
1.1.5 - Fields (Retorno de campos específicos no resultado)
1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)
1.2 - POST
1.2.1 - Post (Inserir um agendamento de job)
1.2.2 - Post {IdJob}/Trigger
1.2.3 - Post {IdJob}/Restart
1.3 - PUT
1.3.1 - Put (Atualizar um Job)
1.4 - DELETE
1.4.1 - Delete (Deletar um Job)

Observação:

Caso o Job não seja recorrente o comportamento será o seguinte:
Ainda não executado: "status": "active"
Executado com ou sem erro: "status": "completed"
Cancelado ou Desativado: "status": "inactive"

Job recorrente:
Ainda não foi executado: "status": "active"
Todas as outras opções: "status": "inactive",

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

Sucess
Pending
Running
Failure

Recorrência do Job:

Um job pode ser criado para ser agendado e pode ser criado com alguma recorrência.
São permitidos os seguintes tipos de recorrência: Diário (daily), semanal (weekly) e mensal (monthly).
No Swagger é possível visualizar o schema desses itens. Veja a seguir um exemplo:

"daily": {

         "year": 0,

       "month": 0,

       "day": 0,

       "hour": 0,

       "minute": 0
}

"weekly": {

       "daysOfWeek": [

              "string"

       ],

       "hour": 0,

       "minute": 0
}

"monthly": {

       "day": 0,

       "hour": 0,

       "minute": 0
},

Para recorrências do tipo daily, a propriedade "firstExecution" enviada é usada apenas para identificar o fuso horário do cliente e são considerados os valores do objeto daily para criar a data de agendamento.
Como o tipo é diário, ele continuará executando todos os dias nas horas definidas em hour e minute.

Segue abaixo um exemplo de uma execução de processo:
Executaremos a rotina de Cópia de Permissões de Usuários para obter um JobID de execução.

Assim será finalizado a execução do processo:

Na tela de gerenciamento de Jobs, validaremos o ID do Job que foi executado:

Com o método GET (GetOne), recuperaremos uma execução de processo já realizada anteriormente no ambiente.

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler/{jobId}
Exemplo de Configuração:

Domínio: localhost
Porta: 8051
JobId: 102972
Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler/102972

Com o Método POST vamos inserir o agendamento de um Job com os parâmetros obtidos:

Copie o retorno obtido no GetOne e utilize no corpo da requisição Post, alterando as informações que necessita para o processo ser gerado. Para o teste realizaremos a cópia no usuário "teste2":

Ao executar será gerado um novo processo e como retorno positivo terá o novo ID do Job:

Ao validar na MDI, o Job foi carregado corretamente (102973) :

Verificando via Consulta SQL, as permissões do usuário mestre foram também replicadas ao usuário "teste2":

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

Olá,

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

0 Comentários

Olá ,

Olá ,

Olá ,

Olá,