API Reference

Download de documento na linha da grid

Para que serve?

Serve para realizar o download do documento na linha de grid na atividade do processo.

Quando usar?

Esse serviço geralmente é utilizado para fazer o download do documento na linha de 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 estejam na linha de 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, a identificação da linha, 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 ou que tenha permissão de pesquisa em atividades já executadas.

No serviço consultar dados da atividade em grid, 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õesLinkRelease InicialRelease FinalStatus
V1Documentação Técnica5.50 RTM 1.06🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada