Workflow-Endpunkte

file (Datei): Erforderlich. Wählen Sie die vorliegende Datei, die Sie in das System hochladen möchten. Der Medientyp muss eine YXZP-Datei sein.

name (Zeichenfolge): Erforderlich. Geben Sie einen Workflow-Namen ein. Dies ist der Name des Workflows, der in der Server-Benutzeroberfläche angezeigt werden soll.

ownerId (Zeichenfolge): Erforderlich. Geben Sie die ID des Besitzers ein.

workerTag (Zeichenfolge): Optional. Geben Sie das in den Workern definierte Worker-Tag an, um Worker-Knoten Aufträge einfacher zuzuweisen. Weitere Informationen finden Sie auf der Hilfeseite zu Worker.

districtTags (Zeichenfolge): Optional. Übermitteln Sie dies als Array im JSON-Format, z. B. ["id1", "id2"]. Verwenden Sie Bereiche, um freigegebene, öffentliche Workflows nach Tags zu gruppieren, damit Benutzer sie leicht finden können. Weitere Informationen finden Sie auf der Hilfeseite Bereiche.

comments (Zeichenfolge): Optional. Geben Sie Ihre Kommentare ein.

isPublic (boolescher Wert): Erforderlich. Wählen Sie „true“ aus, um den Workflow öffentlich verfügbar zu machen. Wählen Sie „false“ aus, um den Workflow privat zu machen, d. h., dass er öffentlich nicht verfügbar ist.

isReadyForMigration (boolescher Wert): Erforderlich. Wählen Sie aus, ob der Workflow zur Migration bereit ist. Weitere Informationen zur Migration von einer Server-Umgebung in eine andere finden Sie auf der Hilfeseite Workflows für Migration aktivieren.

sourceAppId (Zeichenfolge): Optional. Legt die Quell-App-ID für einen Workflows fest. Sie können diese als die Referenz „sourceId“ für den Endpunkt POST admin/v1/workflows verwenden. Die Angabe einer bereits vorhandenen „sourceAppId“ führt zu einer ungültigen Anforderung.

othersMayDownload (boolescher Wert): Erforderlich. Geben Sie an, ob andere Benutzer diesen Workflow herunterladen dürfen.

othersCanExecute (boolescher Wert): Erforderlich. Geben Sie an, ob andere Benutzer diesen Workflow ausführen dürfen.

executionMode (Zeichenfolge): Erforderlich. Akzeptierte Werte sind „Safe“, „SemiSafe“ und „Standard“. Weitere Informationen zum Ausführungsmodus finden Sie auf der Hilfeseite Sichere und halbsichere Ausführungsmodi: gesperrte Tools, Ereignisse und Datenkonnektoren.

hasPrivateDataExemption (boolescher Wert): Optional. Erteilen Sie eine Ausnahme, damit ein Workflow mit privaten Daten ausgeführt werden kann. Wählen Sie „true“ aus, um eine Ausnahme zuzulassen oder „false“, um eine Ausnahme zu verweigern. Weitere Informationen finden Sie auf der Hilfeseite Workflow-Optionen in Admin.

workflowCredentialType (Zeichenfolge): Erforderlich. Akzeptierte Werte sind „Standard“, „Erforderlich“ und „Spezifisch“.

credentialId (Zeichenfolge): optional. Geben Sie die credentialId für diesen Workflow an.

collectionIds (Zeichenfolge): Optional. Geben Sie die collectionId(s) ein, denen dieser Workflow hinzugefügt werden soll. Übermitteln Sie dies als Array im JSON-Format, z. B.: ["id1", "id2"].

workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID ein, für die Sie eine neue Version hochladen möchten.

file (Datei): Erforderlich. Wählen Sie die tatsächliche Datei aus, die Sie als neue Version in das System hochladen möchten. Der Medientyp muss eine YXZP-Datei sein.

name (Zeichenfolge): Erforderlich. Geben Sie den Workflow-Namen ein. Dies ist der Name des Workflows, der in der Server-Benutzeroberfläche angezeigt werden soll.

ownerId (Zeichenfolge): Erforderlich. Geben Sie die ID des Besitzers ein.

othersMayDownload (boolescher Wert): Erforderlich. Die Standardeinstellung ist „true“.

othersCanExecute (boolescher Wert): Erforderlich. Die Standardeinstellung ist „true“.

executionMode (Zeichenfolge): Erforderlich. Akzeptierte Werte sind „Safe“, „SemiSafe“ und „Standard“. Weitere Informationen zum Ausführungsmodus finden Sie auf der Hilfeseite Sichere und halbsichere Ausführungsmodi: gesperrte Tools, Ereignisse und Datenkonnektoren.

hasPrivateDataExemption (boolescher Wert): Optional. Erteilen Sie eine Ausnahme, damit ein Workflow mit privaten Daten ausgeführt werden kann. Wählen Sie „true“ aus, um eine Ausnahme zuzulassen oder „false“, um eine Ausnahme zu verweigern. Weitere Informationen finden Sie auf der Hilfeseite Workflow-Optionen in Admin.

comments (Zeichenfolge): Optional. Geben Sie Ihre Kommentare ein.

makePublished (boolescher Wert): Erforderlich. Die Standardeinstellung ist „true“. Mit dem Parameter „makePublished“ können Sie steuern, ob die neue Version eines Workflows, den Sie an Server senden, die veröffentlichte Version sein soll oder nicht. Sie können den Wert auf „false“ setzen, wenn Sie den Workflow an Server senden. In dem Fall können dann nur Sie ihn ausführen.

workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie den Typ der Anmeldedaten ein, die für diesen Workflow verwendet werden sollen. Akzeptierte Werte sind „Standard“, „Erforderlich“ und „Spezifisch“.

credentialId (Zeichenfolge): optional. Geben Sie die ID für die Anmeldedaten für diesen Workflow an. Weitere Informationen zu Endpunkten mit Anmeldedaten finden Sie unter Endpunkte mit Anmeldedaten.

view (Zeichenfolge): optional. Wählen Sie aus, wie Sie die Workflow-Informationen anzeigen lassen möchten. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Standard“ und „Vollständig“. Wenn dieser Parameter auf „Standard“ gesetzt ist, wird ein reduziertes Ansichtsobjekt zurückgegeben. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

name (Zeichenfolge): Optional. Geben Sie den Namen des Workflows ein, falls Sie die Workflows nach Namen filtern möchten. Dies ist der Name des Workflows, der in der Server-Benutzeroberfläche angezeigt wird.

ownerId (Zeichenfolge): Optional. Geben Sie die ID des Besitzers ein, falls Sie die Workflows nach dem jeweiligen Besitzer filtern möchten.

createdAfter (Zeichenfolge): Optional. Geben Sie das Datum und die Uhrzeit ein, wonach der Workflow erstellt wurde. Geben Sie Datum und Uhrzeit im ISO8601-Format ein.

createdBefore (Zeichenfolge): Optional. Geben Sie das Datum und die Uhrzeit ein, wovor der Workflow erstellt wurde. Geben Sie Datum und Uhrzeit im ISO8601-Format ein.

workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID ein, um Informationen zu diesem Workflow abzurufen.

workflowId (Zeichenfolge): erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

updateWorkflowContract (Text): Erforderlich. Geben Sie die zu aktualisierenden Workflowinformationen ein.

Beispielwert von updateWorkflowContract:

{
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}

workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID ein, für die Sie das Paket herunterladen möchten.

versionId (Zeichenfolge): Optional. Geben Sie die spezifische Versions-ID eines Workflows ein. Wenn Sie keine Version angeben, wird die veröffentlichte Version heruntergeladen.

workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID ein, für die Sie die Informationen abrufen möchten.

versionId (Zeichenfolge): Optional. Geben Sie die spezifische Versions-ID eines Workflows ein. Wenn Sie keine Version angeben, wird die veröffentlichte Version verwendet.

workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID ein, für die Sie die Informationen abrufen möchten.

sortField (Zeichenfolge): Optional. Geben Sie den Feldnamen ein, nach dem die Ergebnisse sortiert werden sollen.

direction (Zeichenfolge): Optional. Geben Sie hier die Sortierreihenfolge an. Zulässige Werte sind „asc“ (aufsteigend) und „desc“ (absteigend). Wenn keine Sortierung angegeben ist, ist die Standardeinstellung „aufsteigend“.

offset (Zeichenfolge): Optional. Bezieht sich auf den Datensatz, mit dem Ihre Ergebnisse beginnen sollen.

limit (Zeichenfolge): Optional. Bezieht sich auf den letzten Datensatz, mit dem Ihre Ergebnisse enden sollen.

status (Zeichenfolge): Optional. Der Gesamtstatus der Auftragsausführung. Ein abgeschlossener Auftrag kann auch fehlgeschlagen sein. Akzeptierte Werte sind „Abgeschlossen“, „Fehler“, „Wird ausgeführt“ und „In Warteschlange“.

resultCode (Zeichenfolge) Optional. Der Ergebniscode für die Ausführung eines Workflows. Dieser weist auf einen fehlgeschlagenen Workflow, aber auf einen erfolgreich ausgeführten Auftrag hin. Akzeptierte Werte sind „Erfolg“, „Warnung“ und „Fehler“.

workflowId (Zeichenfolge): erforderlich. Geben Sie die zu löschende Workflow-ID ein.

force (boolescher Wert): Optional. Wenn Sie diese Option nicht ausgewählt haben, lautet der Standardwert „false“. Wenn ein Workflow geplant ist, werden durch den auf „true“ gesetzten Parameter alle Zeitpläne gelöscht, bevor der Workflow gelöscht wird.