API Reference

Download de documento em grid

Para que serve?

Serve para realizar o download do documento em grid que ainda não esteja adicionado em uma linha e, portanto, sem a identificação de linha.

Quando usar?

Esse serviço geralmente é utilizado para fazer o download do documento em grid da atividade (sem identificação de linha), como:

  • Visualizar o documento na atividade em andamento onde ainda não foi inserido na linha da grid.

É importante destacar que esse serviço permite realizar o download de documento dos campos de formulário que estejam em grid. Para download de documento nas demais situações em formulário, utilize os serviços:

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), a identificação da GRID, o campo do tipo documento (template), 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.

No serviço incluir documento em grid, retornará as informações do documento (documentId e fileUniqueId). 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õesLinkRelease InicialRelease FinalStatus
V1Documentação Técnica5.50 RTM 1.06🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada