API Reference

Listar documentos

post
https://{protocol}://{host}/service/ecmcore/api/v3/documents

Realiza envio de requisição para listagem de documentos.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Solicita a Página que será apresentada a pesquisa de documentos por template.

int32

Deve ser declarada a quantidade de pesquisas de documentos por template por Páginas.

string

é possível fazer a ordenação dos registros pelos campos de retorno (id, author, fileName, version, fileUniqueId, createdAt e updatedAt) seguido pela ordem de direção (asc e desc).

Body Params
string

Nome do usuário que criou o documento.

string

Nome do arquivo com sua extensão gravado na importação do documento vinculado ao template.

date-time

Deve ser declarada a data e hora. Serão retornados os documentos criados a partir da data e hora informada nesse campo.

date-time

Deve ser declarada a data e hora. Serão retornados os documentos criados até a data e hora informada nesse campo.

date-time

Deve ser declarada a data e hora. Serão retornados os documentos alterados a partir da data e hora informada nesse campo.

date-time

Deve ser declarada a data e hora. Serão retornados os documentos updatedTo até a data e hora informada nesse campo.

integer

Deve ser informado o Código do template.

integer

Deve ser informado o Código da instância do processo.

integer

Deve ser informado o Código do dossiê.

string

Deve ser declarada um texto para pesquisa no conteúdo de documentos nesse campo. Atenção o uso desse filtro pode deixar a pesquisa lenta.

documentData
array of objects
documentData
dossieData
array of objects
dossieData
Headers
string
required

Deve ser informado o domínio do ambiente onde será enviada a requisição para listagem de documentos.

Response

Updated about 2 years ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8

Updated about 2 years ago

Did this page help you?