Para que serve?
Serve para substituir um documento criado ou importado fora da grid na atividade em andamento do processo.
Quando usar?
Esse serviço é geralmente utilizado quando necessário alterar o documento fora da grid que ficará relacionado com a atividade do processo, como:
- Atualização dos dados do documento;
- Complementar os dados do documento com avanço do processo.
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), o código do documento (templateId), a ação a ser tomada (criação ou importação de documento) e o código do template.
Esse serviço só pode ser executado com usuário que é responsável pela atividade em andamento e o usuário precisará ter permissão de edição no modelo do documento (template).
O parâmetro da ação não é obrigatório. Se 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.). Quando ela não é especificada, o documento será mantido.
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.
É necessário informar o tipo de atualização, que pode ser uma revisão que gerará um número sequencial da versão atual para o documento alterado e, quando for do tipo versão, gerará um novo número de versão.
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