API Reference

Obter definições de campos específicos do tipo de documento (template)

Para que serve?

Serve para obter as propriedades dos campos específicos (metadados) do tipo de documento (template).

Quando usar?

Esse serviço geralmente é utilizado para obter as propriedades dos campos específicos do tipo de documento, como:

  • Obter as informações necessárias para preencher valores em campos específicos;
  • Verificar quando as informações específicas são obrigatórias;
  • Verificar quando as informações específicas apresentam validação de dados duplicados ao incluir um novo documento.

Como usar?

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

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

O retorno da execução desse serviço serão as propriedades de campos específicos (metados) do tipo de documento (template).

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

Link da APIs

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

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada