Importer une version de Workflow

Permet de téléverser un fichier .flow pour remplacer la configuration actuelle du Workflow et de l'enregistrer comme nouvelle version.

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/import

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/import' \ -H 'Authorization: Bearer ${token}' \ -F 'file=@/path/to/workflow.flow' \ -F 'versionDesc=Update workflow nodes'

                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \
  -H 'Authorization: Bearer ${token}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'versionDesc=Update workflow nodes'

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	multipart/form-data	Formulaire de téléversement de fichier.

Paramètres de la requête (Form Data)

Champ	Type	Description	required
file	File	Fichier `.flow`.	true
versionDesc	String	Description de la version.	false

Réponse

Corps de la réponse

{ "code": 0, "message": "OK", "data": { "botId": "workflow-xxxx", "botType": "FLOW_AGENT", "version": "v2", "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "botId": "workflow-xxxx",
    "botType": "FLOW_AGENT",
    "version": "v2",
    "warning": null
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
botId	String	ID du Workflow cible.
botType	String	Type de Bot.
version	String	Numéro de version enregistré, qui devient également la version actuelle.
warning	String	Message d'avertissement d'importation ; `null` s'il n'y en a pas.

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