Para que serve?
Serve para consultar os valores iniciais dos campos do formulário de processo numa determinada atividade, isto é, os valores definidos na configuração da atividade no Studio.
Quando usar?
Essa consulta pode ser utilizada, por exemplo, para:
- Obter os valores iniciais da atividade para exibir o formulário em outro sistema;
- Obter os valores iniciais para gravar na atividade;
- Obter os valores iniciais para apoiar a decisão de aprovação ou rejeição da atividade.
É importante destacar que esse serviço apenas consulta os valores iniciais. Para que esses valores sejam gravados na atividade e levados às próximas etapas do fluxo, utilize o serviço "Atualizar dados da atividade". Os valores já gravados devem ser consultados pelos serviços "Consultar dados da atividade" e "Consultar dados da atividade em grid".
Como usar?
Para utilizar esse serviço, devem ser informadas a identificação da instância do processo e a da atividade (código da atividade e ciclo). Esse serviço pode ser executado por um usuário responsável pela atividade.
Como retorno, será apresentada uma lista com o nome do campo e o seu valor inicial, somente dos campos com inicialização configurada na atividade (valor fixo, variável de ambiente, valor de outro campo, resultado de select ou integração). Campos ocultos e invisíveis também são retornados. Quando a inicialização não produz valor, o campo é retornado vazio.
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 | 6.0 RTM 1.00.16 (aguardando liberação para o mercado) | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada