Restaurer une version de Workflow

Permet de restaurer une version historique spécifiée d'un Workflow en l'enregistrant comme nouvelle version, avec possibilité de la publier immédiatement.

Cette interface utilise la clé API Key du Workflow cible pour l'authentification et ne peut être appelée que par les Workflows ayant activé l'autorisation de gestion des versions.

Méthode de requête

POST

URL de la requête

https://api.${endpoint}/v1/workflow/version/rollback

Authentification de la requête

Pour plus de détails, consultez les explications sur la méthode d'authentification dans la Présentation de l'API. Veuillez utiliser la clé API Key du Workflow cible comme token.

Requête

Exemple de requête

curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "version": "v1", "new_version": "v3", "release": true, "version_desc": "Rollback to stable workflow" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \
  -H 'Authorization: Bearer ${token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "v1",
    "new_version": "v3",
    "release": true,
    "version_desc": "Rollback to stable workflow"
  }'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${token}	Utilisez la clé API Key du Workflow cible pour l'authentification des appels.
Content-Type	application/json	Format du corps de la requête.

Paramètres de la requête (Body Parameters)

Champ	Type	Description	required
version	String	Numéro de la version source à restaurer.	true
new_version	String	Nouveau numéro de version enregistré après la restauration ; généré automatiquement s'il est vide.	false
release	Boolean	Indique s'il faut publier immédiatement après l'enregistrement de la restauration.	false
version_desc	String	Description de la nouvelle version.	false

Réponse

Corps de la réponse

{ "code": 0, "message": "OK", "data": { "source_version": "v1", "new_version": "v3", "created": true, "released": true, "warnings": [] } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "source_version": "v1",
    "new_version": "v3",
    "created": true,
    "released": true,
    "warnings": []
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
source_version	String	Numéro de la version source de la restauration.
new_version	String	Nouveau numéro de version enregistré.
created	Boolean	Indique si une nouvelle version a été créée.
released	Boolean	Indique si la version a été publiée.
warnings	String[]	Remarques concernant la restauration.

Réponse en cas d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Message d'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante ou API Key sans autorisation de gestion des versions
429	Requêtes trop fréquentes
500	Erreur du serveur