API Reference

Desvincular documento em grid

Para que serve?

Serve para retirar o vínculo de documento de um determinado campo (template) da grid com identificação da linha 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.

Quando usar?

Esse serviço é geralmente utilizado para desvincular um documento em grid com a identificação da linha, 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 Excluir documento em grid.

É importante destacar que esse serviço permite remover o vínculo do documento no campo do formulário que esteja em grid com a identificação da linha. Para desvincular o documento em campos fora da grid, utilize os serviços Desvincular documento ou quando dentro da grid e possuir a identificação da linha, utilize o Desvincular documento na linha da 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), bem como a identificação da grid, do campo da 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 Informações do documento em grid.

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