API Reference

Aprovar ou rejeitar atividade

Para que serve?

Serve para Aprovar ou Rejeitar uma atividade que está em andamento e dar sequência no fluxo de trabalho. Quando a última atividade do processo é aprovada, o processo é finalizado.

Quando usar?

Esse serviço geralmente é utilizado para aprovar ou rejeitar uma atividade, como:

  • Após a atualização de valores de negócio específicos do processo, realizar a aprovação da atividade para dar sequência no fluxo de trabalho;
  • Aprovar uma atividade de ciência e dar sequência no fluxo de trabalho;
  • Rejeitar uma atividade.

É importante destacar que esse serviço apenas faz a aprovação ou rejeição da atividade. Para atualizar os dados de negócio do processo, utilize o serviço "Atualização dos dados da atividade do processo".

Como usar?

Na chamada do serviço é preciso passar a identificação da instância do processo e da atividade em andamento (código da atividade e o ciclo), bem como a ação a ser realizada (aprovar ou rejeitar).

Esse serviço só pode ser executado com um usuário que é responsável pela atividade, que ela esteja em andamento e serão validados os campos de negócio do formulário obrigatórios.

Serão retornadas diversas informações, como:

  • Código da instância do processo;
  • Código do processo;
  • Versão do processo;
  • Indica o status da atividade aprovada ou rejeitada da instância do processo;
  • Informações sobre integrações executadas;
  • Mensagem customizada a ser exibida na aprovação/rejeição;
  • Indica se a atividade aprovada ou rejeitada é a última atividade do processo;
  • Informações referente à próxima atividade;
  • Informações referente aos responsáveis da próxima atividade.

Existem situações que uma atividade não pode ser rejeitada. São elas:

  • Atividade inicial ou final: somente poderá ser aprovada por esse serviço ou cancelada a partir do serviço Cancelar processo;
  • Atividade que não apresenta configuração de rejeição;

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Link da APIs

VersõesLinkRelease InicialRelease FinalStatus
v2Documentação Técnica5.60 RTM 1.02🟢
v1Documentação Técnica5.50 RTM 1.06🟡

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada