Para que serve?
Serve para consultar as informações de documento em qualquer campo template fora da grid.
Quando usar?
Esse serviço geralmente é utilizado para ver as informações especificas de um documento de uma determinada atividade, como:
- Obter as informações de identificação de um documento para manutenção;
- Obter as informações de versão, autor e data de criação do documento;
- Obter as informações de documento 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.
O serviço permite consultar as informações de um documento, sendo os valores principais do documento e os valores dos campos de informações específicas (metadados), fora da grid, porém, não permite realizar o download do documento.
Para realizar o download do documento, utilize o serviço:
Para consultar as informações do documento em grid ou na linha da grid 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 do campo, o código do documento (templateId) e a identificação do arquivo de documento através do campo fileUniqueId.
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.
O fileUniqueId é uma identificação do documento e é obtida no momento da inclusão do documento na atividade. Caso não tenha essa informação, é necessário utilizar o serviço:
O retorno da execução desse serviço serão as informações principais do documento referentes a inclusão do mesmo, com códigos de identificação, versão, tipo do arquivo, data de criação, informações específicas (metadados) e etc.
Com essas informações é possível por exemplo executar os serviços de manutenção ou download de documentos.
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.60 RTM 1.00 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada