API atual/Referência completa/Fluxos operacionais

Fluxos: ativar, pausar, testar

Valida o desenho de um fluxo sem executar nada, liga o fluxo e o pausa.

O ciclo é rascunho, ativo, pausado. test confere o desenho e não executa ações. activate repete a mesma conferência e, se passar, liga o fluxo: a partir daí cada evento do gatilho cria uma execução. pause desliga. Todas exigem manage_ops_flows.

Testar

POST/api/v1/admin/ops-flows/{id}/testAdmin

Validar o desenho (simulação)

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (testar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/test" \
  -H "Authorization: Bearer $TOKEN"

Resposta (testar)

200Desenho válido

json

{
  "ok": true
}

200Desenho inválido

json

{
  "ok": false,
  "reason": "flow must have at least one exit",
  "invalid_nodes": null
}

Campos da resposta

okboolean

true se o desenho passou na validação.

reasonstring

Motivo, em inglês, quando ok é false.

invalid_nodesarray|null

Ids das etapas sem ligação de entrada, quando é esse o problema.

Erros (testar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["manage_ops_flows"]}`
404	O fluxo não existe (ou foi apagado).	`{"error":"not found"}`

Ativar

POST/api/v1/admin/ops-flows/{id}/activateAdmin

Ativar um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (ativar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ativar)

200Ativado

json

{
  "status": "active"
}

Campos da resposta

statusstring

active.

Erros (ativar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["manage_ops_flows"]}`
422	Desenho inválido. O corpo traz `error: invalid_graph`, `reason` e `invalid_nodes`.	`{"error":"invalid_graph","invalid_nodes":null,"reason":"flow must have at least one exit"}`
422	Limite de 50 fluxos ativos atingido, ou falha ao gravar.	`{"error":"failed","detail":"active flow limit (50) reached"}`

Pausar

POST/api/v1/admin/ops-flows/{id}/pauseAdmin

Pausar um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (pausar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta (pausar)

200Pausado

json

{
  "status": "paused"
}

Campos da resposta

statusstring

paused.

Erros (pausar)

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

Veja também

API atual/Referência completa/Fluxos operacionais

Fluxos: ativar, pausar, testar

Valida o desenho de um fluxo sem executar nada, liga o fluxo e o pausa.

Testar

POST/api/v1/admin/ops-flows/{id}/testAdmin

Validar o desenho (simulação)

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (testar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/test" \
  -H "Authorization: Bearer $TOKEN"

Resposta (testar)

200Desenho válido

json

{
  "ok": true
}

200Desenho inválido

json

{
  "ok": false,
  "reason": "flow must have at least one exit",
  "invalid_nodes": null
}

Campos da resposta

okboolean

true se o desenho passou na validação.

reasonstring

Motivo, em inglês, quando ok é false.

invalid_nodesarray|null

Ids das etapas sem ligação de entrada, quando é esse o problema.

Erros (testar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["manage_ops_flows"]}`
404	O fluxo não existe (ou foi apagado).	`{"error":"not found"}`

Ativar

POST/api/v1/admin/ops-flows/{id}/activateAdmin

Ativar um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (ativar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ativar)

200Ativado

json

{
  "status": "active"
}

Campos da resposta

statusstring

active.

Erros (ativar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["manage_ops_flows"]}`
422	Desenho inválido. O corpo traz `error: invalid_graph`, `reason` e `invalid_nodes`.	`{"error":"invalid_graph","invalid_nodes":null,"reason":"flow must have at least one exit"}`
422	Limite de 50 fluxos ativos atingido, ou falha ao gravar.	`{"error":"failed","detail":"active flow limit (50) reached"}`

Pausar

POST/api/v1/admin/ops-flows/{id}/pauseAdmin

Pausar um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Exemplo de requisição (pausar)

bash

curl -X POST "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta (pausar)

200Pausado

json

{
  "status": "paused"
}

Campos da resposta

statusstring

paused.

Erros (pausar)

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