Para que serve?
Serve para consultar os valores dos campos do formulário (exceto em grid) de processo numa determinada atividade.
Quando usar?
Esse serviço geralmente é utilizado para ver os valores dos campos de uma determinada atividade, como:
- Obter as informações de uma atividade e realizar a integração com outros sistemas (ERP, CRM, etc.);
- Obter as informações de uma atividade e com base nos dados de negócios, tomar uma ação de aprovação ou rejeição da atividade;
- Obter as informações de uma atividade para exibi-la em um outro sistema;
Essa consulta poderá ser executada em qualquer situação de um processo, ou seja, em andamento, finalizado ou cancelado.
É importante destacar que esse serviço permite consultar os valores dos campos de formulário que não estejam em grid. Para consultar os valores de campos em grid, utilize o serviço: Consultar os dados da atividade com Grid
Para realizar o download de documentos, utilize o serviço: Download de documentos
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).
Esse serviço pode ser executado a partir de um usuário responsável pela atividade em andamento ou que tenha permissão de pesquisa em atividades já executadas.
Será retornada uma lista de informações com:
- nome do campo;
- valor do campo.
Para campos de documentos (template), o conteúdo será um texto no seguinte formato: fileName:fileUniqueId:documentId.
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Link da APIs
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v2 | Documentação Técnica | 5.50 RTM 1.06 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada