API Reference

Consultar atividades pendentes por usuário

post
{protocol}://{host}/service/bpm/api/v4/users/me/activities

Lista as atividades de instâncias de processos que estão pendentes sob responsabilidade do usuário e que devem dar andamento.

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: Consultar atividades pendentes por usuário

Query Params
int32

O campo page serve para definir qual página será retornada com os dados correspondentes.
Pode ser usado associado ao campo size, que define quantos elementos serão retornados por página.
Quando não for informado nenhum valor ou o valor inserido for inválido, automaticamente o valor será 0.

int32

O campo size é associado ao campo page e define quantos resultados serão retornados por página.
Quando não for informado nenhum valor ou o valor inserido for inválido, automaticamente o valor será 10.

Body Params

Deve ser informado um campo status e seu valor em formato json (application/json) na declaração na estrutura do body.

Conjunto dos filtros para requisição da consulta de atividade do processo instanciado.

boolean

Lista as atividades que utilizam o novo formulário

true= Lista as atividades pendentes no formulário novo

false = Lista atividades pendentes no formulário antigo

vazio = Lista as atividades pendentes tanto no formulário antigo quanto no formulário novo

integer

Lista as atividades a partir do código do processo.

Não informando o código do processo, serão listados todas as atividades pendentes para o usuário.

integer

Lista as atividades a partir da versão dos processos.

Não informado a versão serão listadas todas atividades pendentes para o usuário.

integer

Lista a atividade a partir do processo instanciado

integer

Lista as atividades a partir do código da atividade.

Não informando o código da atividade, serão listados todas as atividades pendentes para o usuário.

boolean

Lista as atividades que estão visualizadas.

true = Lista atividades pendentes que foram visualizadas

false = Lista atividades pendentes que não foram visualizadas

* ao não informar o valor no campo listam as atividades pendentes independentemente se foram visualizadas ou não.

statusList
array of strings

Lista as atividades a partir de seu status atual

OPENED = Lista atividades em aberto

IN_PROGRESS = Lista atividades em progresso

ON_ALERT = Lista atividades em alerta

DELAYED - Lista atividades em atraso

statusList
string

São listadas as atividades que foram iniciadas a partir da data informada.

Entende esse campo como a data inicial de um período (de activityStartDateFrom até actvitityStartDateTo) para consultar as atividades pendentes.

string

São listadas as atividades que foram iniciadas até a data informada.

Entende esse campo como a data final de um período (de activityStartDateFrom até actvitityStartDateTo) para consultar as atividades pendentes.

string

São listadas as atividades de instâncias de processos que foram iniciadas a partir da data informada.

Entende esse campo como a data inicial de um período (de processInstanceStartDateFrom até processInstanceStartDateTo) para consultar as atividades pendentes.

string

São listadas as atividades de instâncias de processos que foram iniciadas até a data informada.

Entende esse campo como a data final de um período (de processInstanceStartDateFrom até processInstanceStartDateTo) para consultar as atividades pendentes.

string

São listadas as atividades com prazo para dar andamento a partir da data informada.

Entende esse campo como a data inicial de um período (de dueDateFrom até dueDateTo) para consultar as atividades pendentes e com prazo para dar andamento.

string

São listadas as atividades com prazo para dar andamento até a data informada.

Entende esse campo como a data final de um período (de dueDateFrom até dueDateTo) para consultar as atividades pendentes e com prazo para dar andamento.

string

Lista a atividade pendente a partir do seu título.

string

Lista a atividade pendente a partir do título do processo.

openedBy
array of strings

Listam as atividades que foram abertas a partir de um ou mais usuários.

Esse parâmetro permite que seja informado mais de um usuário para a consulta.

openedBy
resultFields
array

Listam as atividades a partir de campos de resultados configurados.

Esse parâmetro permite que seja informado mais de um campo de resultado para consulta.

resultFields
Headers
string
required

Deve ser informado o domínio do ambiente onde será retornada a listagem da definição dos campos da atividade do processo.

boolean

Utilizado para executar a requisição no modo teste (simulação).

true = modo teste habilitado

false = modo teste desabilitado

* ao não informar valor para test-mode a requisição será executada em modo normal

integer

Utilizado para executar a requisição a partir do código usuário no modo teste (simulação).

Caso não declarado o código do usuário para simulação, o próprio usuário autenticado será considerado no modo teste.

Response

Updated almost 2 years ago

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 almost 2 years ago