Workflow-Importdatei vorprüfen

Ermöglicht die Vorprüfung, ob eine .flow-Datei importiert werden kann, ohne Geschäftsressourcen zu schreiben.

Über diese Schnittstelle können Sie vorprüfen, ob eine .flow-Datei importiert werden kann. Die Vorprüfung analysiert und scannt die Datei nur sicherheitstechnisch; sie legt keine Workflow, API Key, Datengruppen oder Plugin-Beziehungen an.

Anfragemethode

POST

Anfrage-URL

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

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene; das aufrufende Konto muss über die Berechtigung zum Erstellen von Workflow der Organisation verfügen.

Anfrage

Beispielanfrage

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

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	multipart/form-data	Formular für den Datei-Upload.

Anfrageparameter (Form Data)

Parameter	Typ	Beschreibung	required
file	File	`.flow`-Datei.	true
org_id	String	Organisations-ID.	true

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": { "valid": true, "error_message": null, "export_type": "WORKFLOW", "bot_type": "WORKFLOW", "name": "Imported Workflow", "logo": "https://cdn.example.com/workflow.png", "introduction": "Workflow introduction", "format_version": "1.0" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "valid": true,
    "error_message": null,
    "export_type": "WORKFLOW",
    "bot_type": "WORKFLOW",
    "name": "Imported Workflow",
    "logo": "https://cdn.example.com/workflow.png",
    "introduction": "Workflow introduction",
    "format_version": "1.0"
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
valid	Boolean	Ob die Datei importiert werden kann.
error_message	String	Fehlermeldung, wenn ein Import nicht möglich ist.
export_type	String	Typ der Exportdatei.
bot_type	String	Bot-Typ.
name	String	Ressourcenname in der Datei.
logo	String	URL des Symbols.
introduction	String	Einführung.
format_version	String	Formatversion der Datei.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler