Listar documentos

get

https://{protocol}://{host}/service/ecmcore/api/v2/documents

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

O que precisa saber antes de usar este serviço?

Se você ainda não viu, acesse a documentação de negócios: Listar documentos

Query Params

templateId

integer

Deve ser informado o Código do template.

processInstanceId

integer

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

dossieId

integer

Deve ser informado o Código do dossiê.

author

string

Deve ser declarada o autor do documento criado.

fileName

string

Deve ser declarada o nome do arquivo vinculado ao documento.

createdFrom

date-time

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

createdTo

date-time

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

updatedFrom

date-time

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

updatedTo

date-time

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

page

int32

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

size

int32

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

sort

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).

Headers

X-Server

string

required

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

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json;charset=UTF-8

O que precisa saber antes de usar este serviço?

200Estrutura de recebimento dos valores após execução da requisição de busca de documentos