Para que serve?
Serve para realizar o download do documento (exceto em grid) na atividade do processo.
Quando usar?
Esse serviço geralmente é utilizado para fazer o download do documento fora da grid da atividade, como:
- Visualizar o documento em qualquer atividade;
- Obter um documento para anexar em e-mail.
É importante destacar que esse serviço permite realizar o download de documento dos campos de formulário que não estejam em grid. Para download de documento de campos em grid, utilize o serviço:
Inserir informações sobre dados quando estão em temporários e quando já estão na linha da grid (Para eugenio)
Como usar?
Na chamada do serviço é preciso passar a identificação da instância do processo e da atividade (código da atividade e o ciclo), bem como o campo do tipo template do formulário que apresenta as informações do documento, o código do documento e a identificação do arquivo (fileUniqueId) na plataforma.
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.
No serviço consultar dados da atividade, o campo de documento retorna as seguintes informações: fileName:fileUniqueId:documentId. A partir dessas informações é possível passar os dados para realizar o download.
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 |
|---|---|---|---|---|
| V1 | Documentação Técnica | 5.50 RTM 1.06 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada