Para que serve?
Serve para atualizar, isto é, gravar os valores dos campos do formulário de processo numa determinada atividade em andamento.
Quando usar?
Esse serviço geralmente é utilizado para atualizar os valores de negócio específicos do processo, como, na solicitação de compra, informar todos os dados de negócio para poder abrir a demanda.
Esse mesmo serviço deve ser utilizado para atualizar as informações de negócio de um processo em qualquer atividade e quantas vezes necessitar, desde que esteja em andamento. Se a atividade já estiver aprovada, rejeitada, finalizada ou cancelada, não será possível realizar as alterações de valores dos campos, pois a atividade não estará em andamento.
É importante destacar que esse serviço apenas faz a atualização das informações. Para realizar a aprovação ou rejeição da atividade, utilize o serviço "Aprovação e rejeição de processos".
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), além dos campos de negócio do formulário e seus respectivos valores, que são informados na seção "fields".
Esse mesmo serviço permite que sejam atualizados os dados de GRID. Para isso, as informações devem ser fornecidas na seção "dataGrids". Nela, é possível passar um conjunto de linhas por ação de: inclusão, atualização e exclusão. Tudo isso pode ser feito para todas as GRIDs existentes no formulário.
Esse serviço não possui dados específicos de retorno.
Para consultar todos os detalhes, utilize o link da API no final dessa seção para acessar a documentação técnica.
Documentos (templates)
Os campos de documento, conhecidos como "templates", devem possuir o conteúdo: fileName:fileUniqueId
Por exemplo:
Lorem_Ipsum.pdf:7aa10f98-b3bd-46d3-9936-ee62811cc3bd
Assim, antes de executar esse serviço de Atualização dos Dados, é necessário ter essa informação. Para isso, deve-se efetuar o upload do arquivo ou criá-lo através de serviços que retornam os dados do documento para o vínculo com o processo. Existem serviços especializados quando o campo está fora ou dentro de GRID, bem como, se a informação já está armazenada no banco de dados:
Esses serviços são distintos porque a plataforma valida se o usuário possui permissão em cada campo de documento.
Além disso, caso a instância de processo já possuir no banco de dados um documento vinculado ao campo, não é possível submeter um novo arquivo. Para substituir o documento, existem duas formas:
- Utilizar os serviços de substituição de arquivo:
* [Substituir Documento](https://lecomsa.readme.io/v2.0/reference/importa%C3%A7%C3%A3o-ou-cria%C3%A7%C3%A3o-de-arquivos-em-um-documento-j%C3%A1-existente);
* [Substituir Documento na GRID a partir de uma linha](https://lecomsa.readme.io/v2.0/reference/editar-documento-importar-ou-criar-documento-para-campo-template-de-uma-linha-da-grid-a-partir-de-um-documento-j%C3%A1-existente);
- Utilizar os serviços de desvinculação de arquivo e realizar uma nova importação ou criação de documento:
* [Desvincular Documentos](https://lecomsa.readme.io/v2.0/reference/desvincular-documento-para-campo-template-de-uma-atividade-a-partir-de-um-documento-j%C3%A1-existente);
* [Desvincular Documentos na GRID a partir de uma linha](https://lecomsa.readme.io/v2.0/reference/desvincular-documento-para-campo-template-de-uma-atividade-a-partir-de-um-documento-j%C3%A1-existente-em-uma-grid-com-a-linha-1).
Link da API
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v2 | Documentação Técnica | 5.50 RTM 1.06 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada