Para o workflow (pausa e cancela as execuções em andamento)
POST/api/workflows/{id}/stop
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- Non accetta chiavi API
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Só owner e admin, com o workflow ligado ou pausado (senão 409 `workflows.notStoppable`). Numa transação, o workflow fica pausado e toda execução em andamento é cancelada (`status: CANCELED`, `endedReason: stoppedByTeam`): nada do que estava esperando (inclusive "aguardando cota") é enviado. "Pausar" congela as execuções; "Parar" cancela. Devolve o workflow com `canceledRuns`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
La specifica non dichiara i campi di questo corpo (un upload multipart, per esempio). Consulta la guida dell’argomento.
Risposte
| Codice | Descrizione |
|---|---|
200 | O workflow, pausado, com `canceledRuns`. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/workflows/<id>/stop" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'