Skip to main content
Activer ou désactiver un workflow

Authorizations

Authorization
string
header
required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID
string

Partner-generated correlation identifier echoed in logs and error payloads.

Idempotency-Key
string
required

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.

Maximum string length: 255
Pattern: ^[!-~]+$

Path Parameters

workflow_id
string
required

Clé du workflow; certaines routes utilisent une chaîne, d'autres un UUID. Respectez le type de cette route.

Response

Successful response

id
string
required

Clé du workflow, pas nécessairement un UUID.

name
string
required

Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.

description
string
required

Description libre de la ressource.

type
string
required

Famille de traitement de cette définition de workflow.

schedule
string
required

Planification actuelle du workflow.

enabled
boolean
required

Indique si cette définition est activée.

custom
boolean
required

Indique si le workflow est une définition personnalisée.

editable
boolean
required

Indique si cette définition de workflow peut être modifiée.

deletable
boolean
required

Indique si cette définition de workflow peut être supprimée.

toggleable
boolean
required

Indique si cette définition de workflow peut être activée ou désactivée.

source
string
required

Origine de cette définition de workflow; distingue les workflows système des workflows personnalisés.

scope
string
required

Périmètre métier couvert par le workflow; distinct des scopes d'autorisation de la clé API.

impact
string
required

Indication de l'effet métier attendu du preset.

job_types
string[]
required

Types de traitements associés à cette définition de workflow.

preset_key
string | null
required

Clé du preset de workflow; utiliser une valeur du catalogue de presets.

status
string
required

État de la définition de workflow: draft, active, inactive ou error. Distinct du résultat d'une exécution.

schedule_kind
string | null
required

Mode de planification: utiliser une valeur du catalogue de presets.

schedule_config
object
required

Objet JSON métier; les clés dépendent de la source ou du preset.

config
object
required

Objet JSON métier; les clés dépendent de la source ou du preset.

last_run_at
string<date-time> | null
required

Date de la dernière exécution du workflow.

next_run_at
string<date-time> | null
required

Date de la prochaine exécution planifiée, si elle existe.

last_error
string | null
required

Dernière erreur enregistrée pour cette définition de workflow.