Workflow-Version importieren

Ermöglicht das Hochladen einer .flow-Datei, um die aktuelle Workflow-Konfiguration zu ersetzen und als neue Version zu speichern.

Diese Schnittstelle verwendet zur Authentifizierung den API Key des jeweiligen Ziel-Workflow und kann nur von Workflow aufgerufen werden, für die die Berechtigung zur Versionsverwaltung aktiviert ist.

Anfragemethode

POST

Anfrage-URL

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

Authentifizierung der Anfrage

Einzelheiten finden Sie in den Erläuterungen zur Authentifizierung in der API-Übersicht. Verwenden Sie den API Key des Ziel-Workflow als token.

Anfrage

Beispielanfrage

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'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${token}	Verwenden Sie den API Key des Ziel-Workflow zur Authentifizierung der Anfrage.
Content-Type	multipart/form-data	Formular für den Datei-Upload.

Anfrageparameter (Form Data)

Parameter	Typ	Beschreibung	required
file	File	`.flow`-Datei.	true
versionDesc	String	Versionsbeschreibung.	false

Antwort

Antwort-Body

{ "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
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
botId	String	Ziel-Workflow-ID.
botType	String	Bot-Typ.
version	String	Gespeicherte Versionsnummer, die zugleich zur aktuellen Version wird.
warning	String	Warnhinweis beim Import; null, wenn keiner vorliegt.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlermeldung.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen oder API Key hat keine Berechtigung zur Versionsverwaltung
429	Zu viele Anfragen
500	Serverfehler