Workflow-Version zurücksetzen

Ermöglicht es, eine bestimmte historische Workflow-Version als neue Version zurückzusetzen und zu speichern, optional mit sofortiger Veröffentlichung.

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

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/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"
  }'

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	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
version	String	Quellversionsnummer, die zurückgesetzt werden soll.	true
new_version	String	Nach dem Zurücksetzen gespeicherte neue Versionsnummer; bei leerem Wert automatisch generiert.	false
release	Boolean	Ob nach dem Zurücksetzen und Speichern sofort veröffentlicht wird.	false
version_desc	String	Beschreibung der neuen Version.	false

Antwort

Antwort-Body

{ "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": []
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
source_version	String	Quellversionsnummer des Zurücksetzens.
new_version	String	Neu gespeicherte Versionsnummer.
created	Boolean	Ob eine neue Version erstellt wurde.
released	Boolean	Ob veröffentlicht wurde.
warnings	String[]	Hinweise zum Zurücksetzen.

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