Activer ou désactiver un workflow
Bascule l’état d’un workflow système ou personnalisé.
Scope requis : workflows:write. Scopes et délégation.
Idempotence : header Idempotency-Key obligatoire. Pour reprendre la même mutation, réutiliser la même clé et le même contenu. Écritures et idempotence.
Authorizations
Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.
Headers
Partner-generated correlation identifier echoed in logs and error payloads.
Required for every write, including environments where replay deduplication is disabled. Reuse the same value when retrying the same logical write and use a new value for a different write.
255^[!-~]+$Path Parameters
Clé du workflow; certaines routes utilisent une chaîne, d'autres un UUID. Respectez le type de cette route.
Response
Successful response
Clé du workflow, pas nécessairement un UUID.
Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.
Description libre de la ressource.
Famille de traitement de cette définition de workflow.
Planification actuelle du workflow.
Indique si cette définition est activée.
Indique si le workflow est une définition personnalisée.
Indique si cette définition de workflow peut être modifiée.
Indique si cette définition de workflow peut être supprimée.
Indique si cette définition de workflow peut être activée ou désactivée.
Origine de cette définition de workflow; distingue les workflows système des workflows personnalisés.
Périmètre métier couvert par le workflow; distinct des scopes d'autorisation de la clé API.
Indication de l'effet métier attendu du preset.
Types de traitements associés à cette définition de workflow.
Clé du preset de workflow; utiliser une valeur du catalogue de presets.
État de la définition de workflow: draft, active, inactive ou error. Distinct du résultat d'une exécution.
Mode de planification: utiliser une valeur du catalogue de presets.
Objet JSON métier; les clés dépendent de la source ou du preset.
Objet JSON métier; les clés dépendent de la source ou du preset.
Date de la dernière exécution du workflow.
Date de la prochaine exécution planifiée, si elle existe.
Dernière erreur enregistrée pour cette définition de workflow.