Skip to main content

Workflow-Endpunkte

Workflow-Endpunkte und Parameter

Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .

Weitere Informationen zu Workflows finden Sie auf der Hilfeseite Workflows .

Einen neuen Workflow hochladen

Um einen neuen Workflow hochzuladen, verwenden Sie den Endpunkt POST {baseURL}/v3/workflows .

Parameter

  • 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"].

Eine neue Version in einen bestehenden Workflow hochladen

Um eine neue Version eines vorhandenen Workflows hochzuladen, verwenden Sie den Endpunkt POST {baseURL}/v3/workflows/{workflowId}/versions .

Parameter

  • 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 .

Alle Workflows abrufen

Um Informationen zu allen Workflow-Datensätzen abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/ .

Parameter

  • 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.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen spezifischen Workflow-Datensatz abrufen

TUm Informationen über einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{workflowId} .

Parameter

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

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen vorhandenen Workflow aktualisieren

m Informationen zu einem vorhandenen Workflow zu ändern, verwenden Sie den Endpunkt PUT {baseURL}/v3/workflows/{workflowId} .

Anmerkung

Um die „ownerId“ zu ändern, muss sich der neue Besitzer im selben Abonnement wie der aktuelle Besitzer befinden.

Parameter

  • 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.

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

  • versionId  (Zeichenfolge): Erforderlich. Geben Sie die Versions-ID ein.

  • makePublished  (boolescher Wert): Optional. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert. 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.

  • ownerId (Zeichenfolge): erforderlich. Geben Sie die Besitzer-ID ein.

  • workerTag  (Zeichenfolge): Erforderlich. Wenn kein Worker-Tag vorhanden ist, verwenden Sie stattdessen .""

  • districtTags  (Zeichenfolge): Erforderlich. Geben Sie die Bereichs-Tags ein. 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): Erforderlich. Geben Sie Ihre Kommentare ein.

  • isPublic  (boolescher Wert): Optional. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert.

  • isReadyForMigration  (boolescher Wert): Optional. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert.

  • othersMayDownload  (boolescher Wert): Optional. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert. Wenn der Wert für einen öffentlichen Workflow auf „false“ gesetzt ist, kann der Workflow nicht verwendet werden.

  • othersCanExecute  (boolescher Wert): Optional. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert. Wenn der Wert für einen öffentlichen Workflow auf „false“ gesetzt ist, kann der Workflow nicht verwendet werden.

  • executionMode  (Zeichenfolge): Optional. Akzeptierte Werte sind „Safe“, „SemiSafe“, „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. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert. Weitere Informationen finden Sie auf der Hilfeseite Workflow-Optionen in Admin .

Workflow-Paket herunterladen

Um ein Workflowpaket herunterzuladen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{workflowId}/package .

Parameter

  • 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.

    Anmerkung

    Wenn die VersionID zweistellig ist, kann die Größenbeschränkung erreicht werden, und Sie erhalten möglicherweise den Fehler „414 - URI Too Long“. In diesem Fall parsen Sie die JSON-VersionID-Zeichenfolge, und schneiden Sie sie nur auf die neueste Version zu. Dadurch wird die Feldlänge unter Kontrolle gehalten.

Anforderungsbeispiel: cURL

curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'

Frageninformationen für einen Workflow abrufen

Um Frageinformationen zu einem Workflow abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{workflowId}/questions .

Parameter

  • 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.

Anforderungsbeispiel: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4bc6e24b78d0b8ff0/package'

Informationen zu Aufträgen für einen spezifischen Workflow abrufen

Um Informationen über Aufträge für einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{workflowId}/jobs .

Parameter

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

  • sortField (Zeichenfolge): Optional.

  • direction (Zeichenfolge): Optional.

  • offset (Zeichenfolge): Optional.

  • limit (Zeichenfolge): Optional.

Anforderungsbeispiel: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be6e24b78d0b8ff0/jobs'

Workflow löschen

Um einen spezifischen Workflow zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/workflows/{workflowId} .

Parameter

  • 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.

Anforderungsbeispiel: cURL

curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a752fdc6e278d0ba40b'

Neuen Auftrag erstellen

Um einen neuen Auftrag zu erstellen und ihn der Warteschlange hinzuzufügen, verwenden Sie den Endpunkt POST /v3/workflows/{workflowId}/jobs .

Parameter

  • workflowId (Zeichenfolge): erforderlich. Geben Sie eine Workflow-ID ein, die geplant werden soll.

  • contract (Text): Geben Sie die folgenden Parameter an, um einen neuen Auftrag zu erstellen:

    • workerTag  (Zeichenfolge): Optional. Geben Sie den zugewiesenen Worker an. Wenn keine Angabe gemacht wird, ist der Wert „none“.

    • credentialId  (Zeichenfolge): Optional. Geben Sie die ID für die Anmeldedaten für diesen Workflow an.

    • questions  (Zeichenfolge): Optional. Geben Sie bei einer analytischen App die Fragen und Antworten zur Ausführung des Workflows an.

    • priority  (Zeichenfolge): Optional. Geben Sie die Priorität für die Ausführung des Zeitplans an. Wählen Sie aus den folgenden Optionen aus: „Low“, „Medium“, „High“ und „Critical“. Wenn keine Angabe gemacht wird, ist der Standardwert „Low“.

ANFORDERUNGSBEISPIEL: cURL

Beispiel für eine Anforderung zum Erstellen eines Auftrags:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' -d '{ \ "workerTag": "", \ "credentialId": "", \ "questions": [], \ "priority": "Low" \ }' 'http://localhost/webapi/v3/workflows/651faa8bde3e5381fd0dac29/jobs'{ "workerTag": "tag1",  "credentialId": "652e6f90ea174cd34f6779d2", "questions": [  {   "name": "Drop_Down",   "value": "true"  } ], "priority": "Low"}

Transfer Workflows and Schedules to a Specified Owner

To transfer a specific workflow to a specific owner, together with schedules if desired, use the PUT {baseURL}/v3/workflows/{workflowId}/transfer endpoint.

Anmerkung

  • Only Curators can use this API endpoint.

  • If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.

  • If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.

  • Workflows can only be transferred to a user with the Artisan or Curator role.

  • If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.

  • If transferring schedules, the new owner must have permission to schedule workflows.

  • If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.

Parameters

  • workflowId (string): Required. Specify the Id of the workflow to transfer.

  • contract (body): Required. Specify the following information:

    • ownerId (string): Specify the Id of the new owner.

    • transferSchedules (Boolean): Specify whether the schedules should be transferred to a new owner together with the workflow. Only the schedules owned by the current workflow owner will be transferred to the new owner.

Request Example: cURL

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferSchedules": true \ }' 'http://localhost/webapi/v3/workflows/7917969784f84bd09442f66996ecb8f3/transfer'

Objektbeziehungen

Wenn Sie einen Workflow hochladen, können Sie erstellte Objekte wie folgt verwenden:

Objekt erstellt: " workflowId " (z. B. "id": "7917969784f84bd0942f66996ecb8f3")

Sie können sie wie folgt verwenden:

Beispiele für eine Postman-Anforderung

GET /v3/workflows/{workflowId}

Use GET /v3/workflows/{workflowId} endpoint.

Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden .

In diesem Abschnitt: