API Reference

Listar definições de campos do processo

Para que serve?

Serve para exibir as configurações dos campos do processo.

Quando usar?

Esse serviço geralmente é utilizado para consultar as configurações dos campos do processo.

Como usar?

Na chamada do serviço é preciso passar a identificação do processo e a versão e é possível restringir a pesquisa para apresentar campos pessoais ou sensíveis.

Esse serviço só pode ser executado a partir do usuário modelista do processo.

O retorno da execução serão os dados de identificação dos campos do processo 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.

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Link da API

VersõesLinkRelease InicialRelease FinalStatus
v4Documentação Técnica6.00 RTM 1.00🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada