iGRPIGRP 3.0Documentation

Processos

Lista e detalhe das instâncias, e como iniciar uma instância via API.

Lista de Instâncias

/process-instances — histórico completo de todas as instâncias (ativas e terminadas).

Contadores de estado: total, a correr, canceladas e concluídas.

Colunas da tabela:

ColunaDescrição
ProcessoNome e chave do processo
Business KeyIdentificador de negócio da instância (ex: número do pedido)
Iniciado PorUtilizador ou serviço que iniciou a instância
VersãoVersão do processo em execução
Iniciado EmData/hora de início
DuraçãoTempo decorrido desde o início (instâncias ativas) ou total (concluídas)
EstadoA correr, suspenso, cancelado, concluído

Filtros: estado, processo, versão, intervalo de datas de início.

Histórico de Processo com instâncias do Registo de Entidade, uma delas concluída

Detalhe da Instância

/process-instances/[id] — página completa de inspeção de uma instância específica.

Cabeçalho: nome do processo (título), número de negócio da instância (process.number, subtítulo), badge de estado.

Cards de resumo

Quatro métricas no topo da página:

CardÍconeO que mostra
Business KeyGitBranchIdentificador único da instância (número do processo)
Iniciado PorUserUtilizador ou serviço que iniciou a instância
Iniciado emCalendarData/hora de início + duração relativa (ex: "há 3 dias")
DuraçãoClockTempo total desde o início; se concluída, mostra também a data de fim (endedAt)

Tabs de detalhe

Mostra a sequência cronológica de todos os eventos da instância: início do processo, entradas e saídas de tarefas, passagens por gateways, erros e fim.

  • N eventos registados (contador no cabeçalho da tab)
  • Cada linha: tipo de evento, nome do elemento BPMN, data/hora
  • Útil para perceber o caminho percorrido no diagrama e o tempo gasto em cada atividade
Detalhe da instância REG-2026-22 concluída, com a linha do tempo dos eventos

Depuração com variáveis

O separador Variáveis mostra o estado atual em tempo real. Usa-o para perceber porque é que um gateway escolheu um caminho específico ou para verificar dados recebidos de um delegate.


Iniciar uma instância via API

Além da interface, qualquer serviço pode iniciar (criar e arrancar) uma instância com um token M2M:

POST /process-instances
Authorization: Bearer <m2m-token>
Content-Type: application/json

{
  "processKey": "registo-entidade",
  "applicationBase": "registos",
  "businessKey": "REG-EXT-0001",
  "priority": 1,
  "variables": [
    { "name": "nomeEntidade", "value": "Exemplo, Lda." },
    { "name": "nif", "value": "123456789" }
  ]
}

Os caminhos são relativos à rota do gateway do process-management-api (http://<slug>:2575/gateway-api/<serviço>-process-management-api, sem /api/v1). processKey e applicationBase são obrigatórios; as variáveis vão como lista name/value. Para criar a instância sem a arrancar usa POST /process-instances/create e depois POST /process-instances/{id}/start.

O m2m-token é um JWT client_credentials obtido do Access Management. Ver API M2M para o fluxo completo.

How is this guide?

Última atualização: