API Reference

Obter informações de campos específicos (metadados) do documento

Para que serve?

Serve para consultar as informações de campos específicos (metadados) do documento.

Quando usar?

Esse serviço geralmente é utilizado para ver as informações de um documento como obter os valores dos campos específicos de um documento para manutenção;

Para consultar os valores de informações do documento utilize o serviço Obter informações de um documento.

Como usar?

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

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

O código do documento (documentId) é obtido no momento da inclusão do documento. Caso não tenha essa informação, é necessário utilizar o serviço Listar documentos.

O retorno da execução desse serviço serão as informações do nome do campo específico e seu valor.

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

Link da APIs

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

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada