Para que serve?
Serve para retirar o vínculo de documento de um determinado campo (template) fora da grid em uma atividade de processo em andamento.
Esse serviço apenas faz a retirada da ligação do documento na atividade em andamento e ele não será excluído.
Como usar?
Esse serviço é geralmente utilizado para desvincular um documento, como:
- Tirar um documento da atividade que foi submetido nela;
- Tirar um documento da atividade que veio de uma atividade anterior;
- Trocar o documento por um novo, que neste caso é necessário desvincular para submeter um outro.
Quando desejar excluir o documento junto com o desvinculo, utilize o serviço Excluir documento.
É importante destacar que esse serviço permite remover o vínculo do documento no campo do formulário que não esteja em grid. Para desvincular o documento em campos em 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 em andamento (código da atividade e o ciclo), bem como o campo do tipo template do formulário que apresenta as informações do documento e o código do documento.
Esse serviço deve ser executado pelo responsável da atividade em andamento.
O código do documento é obtido no momento da inclusão do documento na atividade. Caso não tenha essa informação, é necessário utilizar o serviço Obter informações do documento.
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