Importer et créer un Workflow

Permet de téléverser un fichier .flow et de l'importer en tant que Workflow au sein de l'organisation.

Cette interface permet de téléverser un fichier .flow et de l'importer en tant que Workflow au sein de l'organisation. Après une importation réussie, une API Key est créée automatiquement et la gestion des versions est désactivée par défaut.

Méthode de requête

POST

URL de la requête

https://api.${endpoint}/v1/org/workflow/import

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte et requiert que le compte appelant dispose de l'autorisation de création de Workflow de l'organisation.

Requête

Exemple de requête

curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/workflow.flow' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Workflow' \ -F 'enable_api=true'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Workflow' \
  -F 'enable_api=true'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
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
org_id	String	ID de l'organisation.	true
custom_name	String	Nom de Workflow personnalisé après l'importation.	false
enable_api	Boolean	Indique s'il faut tenter d'activer l'API, `true` par défaut. Si le forfait ne prend pas en charge l'API, l'importation réussit tout de même et renvoie `api_enabled=false`.	false

Réponse

Exemple de réponse

{ "code": 0, "message": "OK", "data": { "workflow_id": "workflow-xxxx", "name": "Imported Workflow", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "workflow_id": "workflow-xxxx",
    "name": "Imported Workflow",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
workflow_id	String	ID du Workflow après l'importation.
name	String	Nom du Workflow.
api_key	String	API Key créée automatiquement, renvoyée une seule fois.
api_enabled	Boolean	Indique si l'API est activée.
version_manage_enabled	Boolean	Indique si la gestion des versions est autorisée ; désactivée par défaut lors de l'importation.
warning	String	Avertissement d'importation.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur