API atual/Referência completa/Fluxos operacionais

Execuções de um fluxo

Lista as execuções de um fluxo e os passos de cada execução, para ver o que aconteceu e por que falhou.

Cada vez que o evento do gatilho acontece com o fluxo ativo, a plataforma cria uma execução (run), uma por evento e por fluxo (o mesmo evento nunca cria duas). A execução percorre o desenho: avalia condições e executa ações, gravando um passo para cada etapa. Leitura exige view_ops_flows ou manage_ops_flows.

Listar execuções

GET/api/v1/admin/ops-flows/{id}/runsAdmin

Listar execuções de um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra pelo resultado.

Exemplo de requisição (execuções)

Resposta (execuções)

200Execuções

Campos da resposta

runsarray

Execuções, da mais nova para a mais antiga.

runs[].iduuid

Id da execução.

runs[].flow_iduuid

O fluxo.

runs[].event_idstring

Identifica o evento que originou a execução (tipo:id).

runs[].entity_typestring

order, product, return ou user.

runs[].entity_idstring

Id da entidade que disparou.

runs[].statusstring

activedonefailed

active em andamento, done concluída, failed falhou.

runs[].current_nodestring

Etapa atual, quando em andamento.

runs[].contextobject

Os dados do evento que as condições usam (veja os campos por gatilho em Gatilhos e ações).

runs[].errorstring

Motivo da falha, quando failed.

runs[].created_atstring

Quando começou.

totalinteger

Quantidade.

Erros (execuções)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Passos de uma execução

GET/api/v1/admin/ops-flows/runs/{runId}/stepsAdmin

Passos de uma execução

Parâmetros de caminho

runIduuidobrigatório

Id da execução.

Exemplo de requisição (passos)

Resposta (passos)

200Passos

Campos da resposta

stepsarray

Um passo por etapa executada.

steps[].node_idstring

Etapa do desenho.

steps[].kindstring

conditionaction

condition ou action.

steps[].resultobject

Resultado: { "branch": "yes" } em condição, ou o retorno da ação.

steps[].errorstring

Erro da etapa, quando falhou.

steps[].created_atstring

Quando rodou.

totalinteger

Quantidade.

Erros (passos)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Veja também

Execuções de um fluxo

Lista as execuções de um fluxo e os passos de cada execução, para ver o que aconteceu e por que falhou.

Listar execuções

GET/api/v1/admin/ops-flows/{id}/runsAdmin

Listar execuções de um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra pelo resultado.

Exemplo de requisição (execuções)

Resposta (execuções)

200Execuções

Campos da resposta

runsarray

Execuções, da mais nova para a mais antiga.

runs[].iduuid

Id da execução.

runs[].flow_iduuid

O fluxo.

runs[].event_idstring

Identifica o evento que originou a execução (tipo:id).

runs[].entity_typestring

order, product, return ou user.

runs[].entity_idstring

Id da entidade que disparou.

runs[].statusstring

activedonefailed

active em andamento, done concluída, failed falhou.

runs[].current_nodestring

Etapa atual, quando em andamento.

runs[].contextobject

Os dados do evento que as condições usam (veja os campos por gatilho em Gatilhos e ações).

runs[].errorstring

Motivo da falha, quando failed.

runs[].created_atstring

Quando começou.

totalinteger

Quantidade.

Erros (execuções)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Passos de uma execução

GET/api/v1/admin/ops-flows/runs/{runId}/stepsAdmin

Passos de uma execução

Parâmetros de caminho

runIduuidobrigatório

Id da execução.

Exemplo de requisição (passos)

Resposta (passos)

200Passos

Campos da resposta

stepsarray

Um passo por etapa executada.

steps[].node_idstring

Etapa do desenho.

steps[].kindstring

conditionaction

condition ou action.

steps[].resultobject

Resultado: { "branch": "yes" } em condição, ou o retorno da ação.

steps[].errorstring

Erro da etapa, quando falhou.

steps[].created_atstring

Quando rodou.

totalinteger

Quantidade.

Erros (passos)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`