Obter dados de um documento

get

{protocol}://{host}/service/bpm/api/v1/process-instances/{processInstanceId}/activity-instances/{activityInstanceId}/cycles/{cycle}/fields/{fieldName}/files/{fileUniqueId}

Realiza o envio de requisição para buscar as informações do documento a partir do arquivo e fileUniqueId presente no campo template da atividade do processo instanciado.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

processInstanceId

integer

required

Deve ser informado o número do processo instanciado para pesquisa do documento

activityInstanceId

integer

required

Deve ser informado o número da atividade do processo para pesquisa do documento

cycle

integer

required

Deve ser informado o número do ciclo da atividade do processo para a pesquisa do documento

fieldName

string

required

Deve ser informado o nome do campo template onde o arquivo está inserido na atividade do processo.

fileUniqueId

string

required

Deve ser informado a “hash” de identificação do documento inserido na atividade do processo.

Headers

X-Server

string

required

Deve ser informado o domínio do ambiente onde será enviada a requisição para consulta do documento na atividade do processo

test-mode

boolean

Header para indicar o uso do Modo Teste. Por padrão a plataforma não trabalha no modo teste.

test-user

integer

Header para indicar qual o id do usuário está sendo simulado qual o header test-mode for igual a true. Caso esse header não seja informado, o próprio usuário autenticado será considerado no modo teste.

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

200OK