Para que serve?
Serve para listar os documentos.
Quando usar?
Esse serviço geralmente é utilizado para listar os documentos e obter os seus respectivos dados.
Como usar?
Na chamada do serviço é preciso definir o tipo de listagem, que pode ser apresentada a partir do código do tipo de documento (templateId), do processo (processIntanceId) ou do dossiê (dossieId) para que sejam retornados os documentos.
É possível restringir a consulta através dos filtros author, nome do arquivo, por data de criação ou modificação dos documentos e realizar a ordenação do resultado a partir de id, author, filename, fileUniqueId, createdAt e updatedAt de acordo com a necessidade.
Esse serviço deve ser executado pelo usuário que tenha permissão ao tipo de documento (templateId).
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ões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| V3 | Documentação Técnica | 6.00 RTM 1.00 | 🟢 | |
| V2 | Documentação Técnica | 5.70 RTM 1.00 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada