Para que serve?
Serve para consultar os valores dos campos do formulário em grid de processo numa determinada atividade.
Quando usar?
Este serviço geralmente é utilizado para ver os valores dos campos de grid 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 grid de formulário. Para consultar os valores de campos fora de grid, utilize o serviço Consulta dos dados da atividade.
Para realizar o download de documentos em grid, utilize o serviço: Download de documentos na Grid a partir de uma linha
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 identificação da grid.
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:
- número da linha da grid;
- nome do campo;
- valor do campo.
Para campos de documentos (template), o conteúdo será um texto no seguinte formato: fileName:fileUniqueId:documentId.
Esse serviço trabalha de forma paginada. Desta forma, na chamada dele podem ser informadas a página e a quantidade de itens por página, que é limitado a 100 itens. Quando não informada a página, são retornados os itens referente a primeira página. Caso não seja informada a quantidade de itens por página, serão retornados 20 itens por página.
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 |
|---|---|---|---|---|
| v3 | Documentação Técnica | 5.60 RTM 1.00 | 🟢 | |
| v2 | Documentação Técnica | 5.50 RTM 1.06 | 🟡 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada