Para que serve?
Serve para incluir um documento através de importação ou criação de um arquivo para campo template em uma atividade em andamento.
Quando usar?
Esse serviço é geralmente utilizado quando necessário incluir documento na plataforma que ficará relacionado com a atividade da instância do processo, como:
- Criar um documento a partir do modelo padrão do template;
- Inserir uma nota fiscal de consumo de viagem;
- Inserir atestados.
Como usar?
Na chamada do serviço é preciso passar a identificação da instância do processo e da atividade em andamento (código da atividade e o ciclo), o campo do documento (template), a ação a ser tomada (criação ou importação de documento) e o código do template (templateId).
Esse serviço só pode ser executado com usuário que é responsável pela atividade em andamento. E, se a ação for de criação de documento, o usuário precisará ter permissão de edição no modelo do documento (template).
Quando a ação for de importação, será necessário submeter o arquivo. Já quando a ação for de criação de documento, é possível informar um modelo padrão ou informar o tipo de arquivo a ser criado (EXCEL, WORD, POWER-POINT, etc.).
Além disso, o modelo 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.
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.
Após importar ou criar o documento na atividade, não será possível realizar uma nova importação ou criação de documento através desse serviço. Caso seja necessário, é preciso desvincular o documento, excluí-lo ou substituí-lo através dos seguintes serviços:
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.50 RTM 1.06 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada