Para que serve?
Serve para incluir um documento através do envio de arquivo ou criação de um documento a partir de um modelo.
Quando usar?
Esse serviço é geralmente utilizado quando necessário incluir documento na plataforma, como:
- Inserir um contrato;
- Inserir cópias de documentos.
Como usar?
Na chamada do serviço é preciso passar o código do tipo de documento (templateId). Quando o tipo do documento possuir um modelo padrão, não há necessidade de enviar um arquivo. Por outro lado, quando não houver, é necessário enviar um arquivo.
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 do documento (metadados). Neste caso, será possível informar os campos e seus respectivos valores. Caso haja campos obrigatórios, eles deverão ser informados.
Os campos de informações específicas do documento (metadados) podem ser configurados para não aceitar valores duplicados. Entretanto, se for preciso inserir essa informação duplicada, basta informar o parâmetro duplicateValues igual a true. A configuração padrão a ser utilizada é false, que faz a validação de valores duplicados.
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Links das 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