Workflow-Version veröffentlichen

Ermöglicht die Veröffentlichung einer bestimmten Workflow-Version als Live-Produktionsversion.

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

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/release' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "version": "v2" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/release' \
  -H 'Authorization: Bearer ${token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "v2"
  }'

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	Versionsnummer, die als Live-Version veröffentlicht werden soll.	true

Antwort

Antwort-Body

{ "code": 0, "message": "OK", "data": { "version": "v2", "previous_version": "v1" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "version": "v2",
    "previous_version": "v1"
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
version	String	In diesem Vorgang veröffentlichte Versionsnummer.
previous_version	String	Vor der Veröffentlichung aktive Live-Versionsnummer; bei der ersten Veröffentlichung leer.

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