Para que serve?
Serve para listar as configurações dos campos da atividade de uma instância de processo.
Quando usar?
Esse serviço geralmente é utilizado para consultar as definições dos campos de formulário de uma determinada atividade de um processo instanciado.
A partir dessa consulta é possível saber todos os campos da atividade e suas propriedades, como nome, legenda, tipo de campo, tamanho máximo, dentre outras.
Essas informações podem ser utilizadas para criação de uma interface.
Como usar?
Na chamada do serviço é preciso passar a identificação da instância do processo e da atividade.
Esse serviço só pode ser executado a partir da chave de API informada do usuário que tem permissão de acesso à atividade da instância de processo informada.
Serão retornadas diversas informações, como:
- Nome do campo;
- Visibilidade;
- Legenda;
- Obrigatoriedade;
- Tamanho máximo;
- Dentre outras.
Como as propriedades podem variar conforme o tipo de campo, recomendamos executar este serviço e analisar detalhadamente o retorno conforme sua necessidade.
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