Para o workflow (pausa e cancela as execuções em andamento)
POST/api/workflows/{id}/stop
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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`.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.
Réponses
| Statut | Description |
|---|---|
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. |
Exemple 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 '{}'