Para que serve?
Serve para consultar as informações de documento.
Quando usar?
Esse serviço geralmente é utilizado para ver as informações de um documento, como:
- Obter as informações de identificação de um documento para manutenção;
- Obter as informações de versão, autor e data de criação do documento;
- Obter as informações de documento para exibi-la em um outro sistema.
Como usar?
Na chamada do serviço é preciso passar o código do tipo de documento (templateId) e o código do documento (documentId).
Esse serviço só pode ser executado pelo usuário que tenha permissão ao tipo de documento (template).
Para obter o código do tipo de documento (templateId) utilize o serviço Consultar os tipos de documentos (template).
O código do documento (documentoId) é obtido no momento da inclusão do documento. Caso não tenha essa informação, é possível consultar através do serviço Listar documentos.
O retorno da execução desse serviço serão as informações principais do documento referentes ao autor, versão, tipo do arquivo, data de criação e etc.
Para consultar os valores de informações específicas (metadados) utilize o serviço Obter informações de campos específicos (metadados) 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.70 RTM 1.00 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada