Objetivo
Este endpoint tem o objetivo de fazer o processo de avanço de um fluxo em especifico, preenchendo seus campos.
URL
/rest/bpms/IntegrationTask/flows/{flowExecutionKey}/activities/{activityName}/executions
Parâmetros
Chave da execução do fluxo “FlowExecutionKey”: Disponivel através do endpoint de listagem de fluxos
Nome da tarefa de usuário “ActivityName”: É o titulo que fica no card do fluxo. Ex:Gestão avalia a solicitação
ExecutorId: Parâmetro utilizado para definir a ID do usuário executor. A ID atribuída à tarefa em questão pode ser consultada pelo endpoint para consulta das tarefas de usuário não concluídas. Caso um papel foi atribuído á atividade em questão os usuários pertencentes a este papel podem ser consultadas através do endpoint de listagem de usuários por papel.
OptionId: Parâmetro disponível através do endpoint para consulta das tarefas de usuário não concluídas.
FormData: Formulário que é disponibilizado no retorno do endpoint para consulta do formulário do fluxo. Dentro deste parâmetro será necessário preencher os campos de acordo com a construção do formulário do fluxo. Confira abaixo detalhes de como preencher cada tipo de campo:
- TextField: Este é um campo de texto simples. Ele é usado para coletar informações curtas, como nomes, títulos ou qualquer outra entrada de texto que não exija várias linhas.
- TextArea: Diferente do campo de texto simples, este é uma área de texto. Ele permite inserir um volume maior de texto, como descrições detalhadas, comentários ou mensagens longas, pois geralmente pode ser redimensionado e suporta quebras de linha.
- Email: Este campo é especificamente para um endereço de e-mail. Este campo possui uma validação, onde só é permitido a inserção no formato de um e-mail, utilizando “@” e um domínio.
- Currency: Este campo é destinado á inserção de valores como moedas. Possui a possibilidade de configuração como “Real” ou “Dólar” quando é criado o formulário. Deve ser preenchido somente o valor em número, o tipo de moeda deve ser configurado já na criação do formulário.
- DateTime: Este campo deve ser preenchido com a data no formato “AAAA-MM-DDThh:mm:ss” (ex:2025-06-21T03:00:00Z), o sistema utilizará o padrão fuso horário UTC±0, e é de responsabilidade do usuário fazer o tratamento correto para o seu horário desejado. Exemplo: Para o Brasil com fuso horário UTC -3 pode-se utilizar o formato AAAA-MM-DDThh:mm:ss-03:00.
- Checkbox: Este é um campo do tipo “caixa de seleção” (checkbox). Ele permite ao usuário marcar ou desmarcar uma opção, indicando um estado verdadeiro(true) ou falso(false).
- Select: Este é um campo de seleção (dropdown). Ele oferece uma lista predefinida de opções para o usuário escolher apenas uma. A predefinição é feita na configuração do formulário do fluxo. As opções podem ser consultadas previamente pelo endpoint para consultado do formulário do fluxo. Caso seja inserida uma opção não existente, o sistema irá retornar ao usuário uma lista das opções disponíveis de serem utilizadas.
- File: O campo “File” pode ser preenchido utilizando a endpoint de upload de arquivo.
- Url: Este campo é destinado á um link (URL), deve ser preenchido corretamente com uma URL valida que irá direcionar ao site informado.
- Number: Este é um campo numérico. Ele aceita apenas números (inteiros ou decimais) e é usado para qualquer tipo de entrada numérica que não seja uma moeda ou data/hora específica.
- Radio: Campo utilizado para apresentar ao usuário um conjunto de opções mutuamente exclusivas. Apenas uma opção pode ser selecionada por vez. As opções podem ser consultadas previamente pelo endpoint para consultado do formulário do fluxo.
- Signature: Campo destinado à captura da assinatura do usuário responsável pela etapa ou validação do processo. Será aceito como valor o formato base64 de qualquer imagem, portanto não será feita nenhuma validação de assinatura aqui.
Mais informações sobre a funcionalidade de cada campo podem ser conferidas clicando aqui.
Retornos
O retorno da requisição será de acordo com o resultado da mesma, se for um erro, o retorno irá informar qual parâmetro está preenchido de forma incorreta. Caso esteja correto o preenchimento, o usuário irá receber o formulário preenchido de acordo com a requisição e uma informação de “Sucess”.
Exemplo de retorno em caso de erro.
Retorno com sucesso, preenchimento correto.