API Reference

Pesquisa avançada de processos

post
https://{protocol}://{host}/service/bpm/api/v2/process-instances/search

Realiza envio de requisição para consulta de instâncias de processos com filtros avançados.

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

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

Se você ainda não viu, acesse a documentação de negócios: Pesquisa avançada de processos

Query Params
integer

Solicita a página que será apresentada a pesquisa dos processos instanciados.

integer

Deve ser declarada a quantidade de pesquisas de processos instanciados por página.

Body Params
integer

Deve ser informado o número da instância do processo a ser pesquisada.

integer

Deve ser informado o código do processo para a consulta das instâncias desse processo.

integer

Deve ser informado o número da versão do processo para a consulta das instâncias de processo dessa versão específica.

boolean

Deve ser informado se a busca será feita em todas as versões do processo. Se verdadeiro, busca em todas as versões do processo.

integer

Número da atividade na qual a instância do processo deve estar.

string
enum
Defaults to PROCESSES_OPENED_IN

Especifica o critério de data a ser aplicado ao intervalo de tempo definido pelos campos startDate e endDate. As opções disponíveis determinam qual evento de data será considerado no filtro:

  • PROCESSES_OPENED_IN: Filtra os processos cuja data de abertura está dentro do intervalo informado.
  • ACTIVITIES_PERFORMED_IN: Filtra os processos que tiveram ao menos uma atividade executada (aprovada) dentro do intervalo informado.

Atenção: Este campo só tem efeito quando startDate e endDate são fornecidos.

Allowed:
date-time

Data de início para o filtro de período.

date-time

Data de fim para o filtro de período.

status
array of objects

Lista de status da atividade das instâncias de processos.

status
order
object

Deve ser informado o campo e a ordem que definirá a ordenação dos resultados.

searchableFields
array of objects

Devem ser informados os campos pesquisáveis para serem usados no filtro da pesquisa.

searchableFields
responsibleFilters
array of objects

Devem ser informados os responsáveis para serem usados no filtro da pesquisa.

responsibleFilters
Headers
string
required

Deve ser informado o domínio do ambiente onde será enviada a consulta das atividades de uma instância do processo

boolean

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

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

Updated 12 months 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

Updated 12 months ago

Did this page help you?