Para que serve?
Serve para consultar todos os processos que poderão ser abertos pelo usuário que realizará a consulta.
Quando usar?
Este serviço geralmente é utilizado para consultar quais processos o usuário tem permissão para abrir novas demandas, como:
- Desenvolvimento de uma interface para abertura de processo em que é necessário consultar quais processos o usuário poderá abrir;
- Ele também pode ser utilizado para consultar atributos de um determinado processo, como sua versão, título, subtítulo.
Como usar?
Na chamada do serviço retorna todos os processos que o usuário tem permissão para abrir e é possível restringir a pesquisa através de filtros como código do processo, versão, título, subtítulo, favoritos, dentre outros campos.
O retorno da execução serão os dados de identificação dos processos listados de forma paginada. Desta forma, na chamada dele podem ser informadas a página e a quantidade de itens por página, que é limitado a 100 itens. Quando não informada a página, são retornados os itens referente a primeira página. Caso não seja informada a quantidade de itens por página, serão retornados 20 itens por página.
Com essas informações é possível por exemplo executar o serviço Abrir processo.
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Link da API
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v3 | Documentação Técnica | 6.00 RTM 1.00 | 🟢 | |
| v2 | Documentação Técnica | 5.60 RTM 1.00 | 🟡 | |
| v1 | Documentação Técnica | 5.50 RTM 1.06 | 🟡 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada