Para que serve?
Serve para excluir o documento de um determinado campo (template) fora da grid em uma atividade de processo em andamento.
Quando usar?
Esse serviço é geralmente utilizado para excluir um documento, como:
- Apagar um documento que foi inserido em uma atividade em andamento que ainda não foi salva;
- Trocar o documento por um novo, que neste caso é possível excluir para submeter um outro.
A partir do momento que um documento estiver vinculado a uma atividade que esteja salva, não é mais permitido realizar a exclusão do documento. Neste caso, só é possível desvincular o documento. Para isso, utilize o serviço: Desvincular documento.
É importante destacar que esse serviço permite excluir o documento no campo do formulário fora da grid. Para excluir o documento em campos dentro da grid, utilize os serviços: Excluir documento em grid.
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), o campo do documento (template) e o código do documento (documentId).
Esse serviço deve ser executado pelo responsável da atividade em andamento e o usuário precisará ter permissão de edição no modelo do documento (template).
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