Objetivo
Este endpoint tem como objetivo obter o formulário associado a um fluxo existente dentro do sistema, permitindo a interação do usuário com os dados.
URL
/rest/bpms/IntegrationTask/flows/{flowExecutionKey}/activities/{activityName}/form-fields
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
Retornos
A resposta do endpoint é um objeto JSON que contém as principais propriedades do formulário sendo:
Value: Este é o objeto central que encapsula todos os dados relevantes do formulário e do contexto do fluxo.
TaskId: Identificador único da tarefa atual à qual este formulário está associado.
ActivityName: Nome descritivo da atividade (ou etapa) do processo em que a tarefa se encontra atualmente.
FlowExecutionKey: Uma chave de execução única que identifica a instância específica do fluxo de trabalho (processo) no iBPMS.
formData: Contém os dados preenchidos no formulário até o momento. Cada chave dentro deste objeto corresponde ao fieldIdentifier de um campo do formulário, e seu valor é o dado associado.
ProcessVersionId: O identificador da versão do processo que está sendo executada.
ProcessName: O nome do processo ao qual esta instância pertence.
FormContent: Uma lista detalhada da estrutura do formulário, descrevendo cada componente (campo ou conteúdo) que deve ser renderizado na interface.
Label: O texto que será exibido para o usuário como o título ou rótulo do campo/componente.
Type: O tipo de componente do formulário. Exemplos incluem:
- Content: Usado para exibir texto estático ou seções informativas no formulário. Não é um campo de entrada.
- Textfield: Um campo de texto de linha única para entrada de dados.
- Datetime: Um campo para seleção de data e/ou hora.
- File: Um campo para upload de arquivos.
- TextArea: Um campo de texto de múltiplas linhas para entrada de dados mais longos.
Input: Indica se o componente é um campo de entrada (true) ou apenas um elemento de exibição (false).
FieldIdentifier: Um identificador único e programático para o campo, usado para mapear o campo na interface com os dados em formData.
Required: Indica se o preenchimento deste campo é obrigatório para o avanço da tarefa.
