API Reference

Listar dossiês

Para que serve?

Serve para listar os dossiês.

Quando usar?

Esse serviço geralmente é utilizado para listar os dossiês.

Como usar?

Na chamada do serviço é retornado os dossiês da plataforma e é possível restringir a consulta através dos filtros nome, descrição ou identificador do dossiê de acordo com a necessidade.

Esse serviço deve ser executado a partir do usuário com as permissões administrador ECM e no módulo Documentos.

Esse serviço trabalha 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 APIs

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

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada