API Reference

Substituir documento

Para que serve?

Serve para substituir um documento importado.

Quando usar?

Esse serviço é geralmente utilizado quando necessário alterar o documento, como na atualização dos dados do documento.

Como usar?

Na chamada do serviço é preciso passar o código do tipo do documento (templateId) e o código do documento (documentId).

Esse serviço deve ser executado pelo usuário que tenha permissão de edição ao tipo de documento (template).

Além disso, o tipo do documento (template) pode ter campos de informações específicas (metadados). Neste caso, será possível informar os campos e seus respectivos valores. Caso haja campos obrigatórios, eles deverão ser informados.

Em relação a importação do arquivo ao substituir o documento, caso não seja selecionado o arquivo atual será mantido.

Também é necessário informar o tipo de atualização, que pode ser uma revisão que gerará um número sequencial da versão atual, uma versão que gerará um novo número de versão para o documento alterado ou sobrescrever onde o número da versão atual do documento será mantido.

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Links das APIs

VersõesLinkRelease InicialRelease FinalStatus
v1Documentação Técnica5.70 RTM 1.00🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada