[Beta]{class="badge informative"}
Process Manager-API
Verwenden Sie die Process Manager-API in Adobe Experience Platform, um Prozessdefinitionen aufzulisten, Ausführungsausführungen zu überprüfen und wiederkehrende Zeitpläne zu verwalten.
Erste Schritte
Bevor Sie die API verwenden, absolvieren Sie das Authentifizierungs-Tutorial. Fügen Sie dann diese Kopfzeilen in jede Anfrage ein:
- Authorization:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID} - x-sandbox-name:
{SANDBOX_NAME}
Auflisten von Prozessdefinitionen list-process-definitions
Sie können alle aktuellen Prozessdefinitionen auflisten, indem Sie eine GET-Anfrage an den /process-definitions-Endpunkt stellen.
API-Format
GET /process-definitions
Abfrageparameter
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| Parameter | Beschreibung |
name |
Filter der Teilzeichenfolge, bei dem der Definitionsname nicht zwischen Groß- und Kleinschreibung unterschieden wird. |
sort |
Feld zum Sortieren nach. Unterstützte Werte sind createdAt, updatedAt und name. Der Standardwert ist createdAt. |
order |
Sortierreihenfolge. Unterstützte Werte sind asc und desc. Der Standardwert ist desc. |
pageSize |
Elemente pro Seite. Unterstützter Bereich: 1 bis 100. Der Standardwert ist 100. |
cursor |
Undurchsichtiger Paginierungscursor, der von einem vorherigen Aufruf zurückgegeben wurde. Sich gegenseitig ausschließend mit offset. |
offset |
Versatz auf Basis null. Sich gegenseitig ausschließend mit cursor. |
Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status 200 mit einer Liste von Prozessdefinitionen zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| Feld | Beschreibung |
definitionUuid |
Die ID der Prozessdefinition. |
name |
Der Name der Prozessdefinition. |
imsOrg |
Die ID der Organisation, zu der die Prozessdefinition gehört. |
sandboxId |
Die ID der Sandbox, zu der die Prozessdefinition gehört. |
sandboxName |
Der Name der Sandbox, zu der die Prozessdefinition gehört. |
tasks |
Ein Array, das die Aufgabenobjekte enthält, die sich auf die Prozessdefinition beziehen. |
tasks.id |
Die ID der Aufgabe. |
tasks.taskType |
Die Art der Aufgabe. Zu den möglichen Werten gehören wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller und send-notification. |
tasks.retry.maxAttempts |
Die Häufigkeit, mit der die Aufgabe wiederholt wird, wenn die Aufgabe fehlschlägt. |
tasks.retry.backoffCoefficient |
|
createdAt |
Datum und Uhrzeit der Erstellung der Prozessdefinition. |
updatedAt |
Datum und Uhrzeit der letzten Aktualisierung der Prozessdefinition. |
createdBy |
Ein -Objekt, das Informationen zu dem Benutzer enthält, der die Prozessdefinition erstellt hat. |
updatedBy |
Ein -Objekt, das Informationen zu dem Benutzer enthält, der die Prozessdefinition zuletzt aktualisiert hat. |
Abrufen einer bestimmten Prozessdefinition
Sie können eine bestimmte Prozessdefinition abrufen, indem Sie eine GET-Anfrage an den /process-definitions-Endpunkt mit Angabe der Prozessdefinitions-ID stellen.
API-Format
GET /process-definitions/{DEFINITION_ID}
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status-Code 200 mit Informationen zur angeforderten Prozessdefinition zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| Feld | Beschreibung |
definitionUuid |
Die ID der Prozessdefinition. |
name |
Der Name der Prozessdefinition. |
imsOrg |
Die ID der Organisation, zu der die Prozessdefinition gehört. |
sandboxId |
Die ID der Sandbox, zu der die Prozessdefinition gehört. |
sandboxName |
Der Name der Sandbox, zu der die Prozessdefinition gehört. |
tasks |
Ein Array, das die Aufgabenobjekte enthält, die sich auf die Prozessdefinition beziehen. |
tasks.id |
Die ID der Aufgabe. |
tasks.taskType |
Die Art der Aufgabe. Zu den möglichen Werten gehören wait, ingest-data, verify-profile-ingestion, run-segmentation, run-profile-export, trigger-activation, run-data-distiller und send-notification. |
tasks.retry.maxAttempts |
Die Häufigkeit, mit der die Aufgabe wiederholt wird, wenn die Aufgabe fehlschlägt. |
tasks.retry.backoffCoefficient |
|
createdAt |
Datum und Uhrzeit der Erstellung der Prozessdefinition. |
updatedAt |
Datum und Uhrzeit der letzten Aktualisierung der Prozessdefinition. |
createdBy |
Ein -Objekt, das Informationen zu dem Benutzer enthält, der die Prozessdefinition erstellt hat. |
updatedBy |
Ein -Objekt, das Informationen zu dem Benutzer enthält, der die Prozessdefinition zuletzt aktualisiert hat. |
Listenprozess-Definitionsdurchgänge list-process-definition-runs
Sie können eine Liste aller Ausführungen für eine Prozessdefinition abrufen, indem Sie eine GET-Anfrage an den /runs-Endpunkt stellen und die ID der Prozessdefinition angeben.
API-Format
GET /runs?{QUERY_PARAMETERS}
Abfrageparameter
definitionUuidexecutionTriggerMANUAL oder SCHEDULE gestartet wurden.Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status-Code 200 mit Informationen zur ausgeführten Prozessdefinition zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Feld | Beschreibung |
runId |
Die ID der Ausführung der Prozessdefinition. |
definitionUuid |
Die ID der Prozessdefinition, zu der die Ausführung gehört. |
definitionName |
Der Name der Prozessdefinition, zu der die Ausführung gehört. |
imsOrg |
Die ID der Organisation, zu der die Prozessdefinition gehört. |
sandboxId |
Die ID der Sandbox, zu der die Prozessdefinition gehört. |
sandboxName |
Der Name der Sandbox, zu der die Prozessdefinition gehört. |
state |
Der Status der Ausführung der Prozessdefinition. Zu den möglichen Werten gehören PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED und TIMED_OUT. |
submittedAt |
Datum und Uhrzeit der Übermittlung der Prozessdefinitionsausführung. |
startedAt |
Das Datum und die Uhrzeit, zu der die Ausführung der Prozessdefinition beginnt. |
events |
Ein Objekt, das die Aufgaben enthält, die im Rahmen der Ausführung der Prozessdefinition ausgeführt werden. |
triggeredBy |
Die Methode, mit der die Prozessdefinition ausgeführt wurde. Mögliche Werte sind MANUAL oder SCHEDULE. |
Abrufen einer bestimmten Prozessdefinition get-process-definition-run
Sie können eine bestimmte ausgeführte Prozessdefinition abrufen, indem Sie eine GET-Anfrage an den /runs-Endpunkt mit Angabe der Ausführungs-ID stellen.
API-Format
GET /runs/{RUN_ID}
{RUN_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status-Code 200 mit Informationen zur angegebenen Prozessdefinitionsausführung zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Feld | Beschreibung |
runId |
Die ID der Ausführung der Prozessdefinition. |
definitionUuid |
Die ID der Prozessdefinition, zu der die Ausführung gehört. |
definitionName |
Der Name der Prozessdefinition, zu der die Ausführung gehört. |
imsOrg |
Die ID der Organisation, zu der die Prozessdefinition gehört. |
sandboxId |
Die ID der Sandbox, zu der die Prozessdefinition gehört. |
sandboxName |
Der Name der Sandbox, zu der die Prozessdefinition gehört. |
state |
Der Status der Ausführung der Prozessdefinition. Zu den möglichen Werten gehören PENDING, RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED und TIMED_OUT. |
submittedAt |
Datum und Uhrzeit der Übermittlung der Prozessdefinitionsausführung. |
startedAt |
Das Datum und die Uhrzeit, zu der die Ausführung der Prozessdefinition beginnt. |
events |
Ein Objekt, das die Aufgaben enthält, die im Rahmen der Ausführung der Prozessdefinition ausgeführt werden. |
triggeredBy |
Die Methode, mit der die Prozessdefinition ausgeführt wurde. Mögliche Werte sind MANUAL oder SCHEDULE. |
Ausführen einer Prozessdefinition start-run
Sie können eine ausgeführte Prozessdefinition starten, indem Sie eine POST-Anfrage an den /runs-Endpunkt senden.
API-Format
POST /runs
Anfrage
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Eigenschaft | Typ | Beschreibung |
definitionUuid |
Zeichenfolge | Die ID der Prozessdefinition, für die Sie einen Durchlauf starten möchten. |
inputs |
Objekt | Ein optionales -Objekt, das Felder enthält, die in der Prozessdefinition erforderlich sind. |
Antwort
Bei einer erfolgreichen Anfrage wird der HTTP-Status 202 Accepted mit den akzeptierten Ausführungsdetails zurückgegeben. Die Ausführung erfolgt asynchron und gibt sofort mit state: PENDING zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 | |
|---|---|
| Feld | Beschreibung |
runId |
Die ID des neu akzeptierten Durchgangs. |
definitionUuid |
Die ID der Prozessdefinition, für die die Ausführung ausgeführt wird. |
definitionName |
Der Name der Prozessdefinition, zu der die Ausführung gehört. |
imsOrg |
Die ID der Organisation, zu der die Prozessdefinition gehört. |
sandboxId |
Die ID der Sandbox, zu der die Prozessdefinition gehört. |
sandboxName |
Der Name der Sandbox, zu der die Prozessdefinition gehört. |
state |
Der Status des Durchgangs. Da dieser Prozess asynchron ist, wird er PENDING. |
submittedAt |
Datum und Uhrzeit der Übermittlung der Prozessdefinitionsausführung. |
startedAt |
Das Datum und die Uhrzeit, zu der die Ausführung der Prozessdefinition beginnt. |
events |
Ein Objekt, das die Aufgaben enthält, die im Rahmen der Ausführung der Prozessdefinition ausgeführt werden. |
triggeredBy |
Die Methode, mit der die Prozessdefinition ausgeführt wurde. Mögliche Werte sind MANUAL oder SCHEDULE. |
Prozessdefinitionsplanung abrufen get-schedule
Sie können den Zeitplan für eine Prozessdefinition abrufen, indem Sie eine GET-Anfrage an den /process-definitions/{DEFINITION_ID}/schedule-Endpunkt stellen und die ID der Prozessdefinition angeben.
API-Format
GET /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status 200 mit Informationen zum Zeitplan für die Prozessdefinition zurück.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
|---|---|
| Feld | Beschreibung |
cron |
Das Cron-Format für den Zeitplan. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation Cron Expression Format . |
paused |
Ein boolescher Wert, der angibt, ob der Zeitplan angehalten wurde oder nicht. |
createdAt |
Datum und Uhrzeit der Erstellung des Zeitplans. |
updatedAt |
Datum und Uhrzeit der letzten Aktualisierung des Zeitplans. |
createdBy |
Ein Objekt, das Details zum Benutzer enthält, der den Zeitplan erstellt hat. |
updatedBy |
Ein Objekt, das Details zum Benutzer enthält, der den Zeitplan zuletzt aktualisiert hat. |
Zeitplan ersetzen replace-schedule
Sie können den Zeitplan für eine Prozessdefinition ersetzen, indem Sie eine PUT-Anfrage an den /process-definitions/{DEFINITION_ID}/schedule-Endpunkt mit Angabe der ID der Prozessdefinition stellen.
API-Format
PUT /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Eigenschaft | Typ | Beschreibung |
cron |
Zeichenfolge | Das Cron-Format für den Zeitplan. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation Cron Expression Format . |
Antwort
Bei einer erfolgreichen Anfrage wird der HTTP-Status 200 mit dem aktualisierten Zeitplan zurückgegeben.
| code language-json |
|---|
|
Prozessdefinitionsplanung entfernen remove-schedule
Sie können den an eine Prozessdefinition angehängten Zeitplan entfernen, indem Sie eine DELETE-Anfrage an den /process-definitions/{DEFINITION_ID}/schedule-Endpunkt stellen und dabei die ID der Prozessdefinition angeben.
API-Format
DELETE /process-definitions/{DEFINITION_ID}/schedule
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt HTTP 204 ohne Antworttext zurück.
Anhalten des angegebenen Zeitplans pause-schedule
Sie können den Zeitplan für eine Prozessdefinition anhalten, indem Sie eine POST-Anfrage an den /process-definitions/{DEFINITION_ID}/schedule:pause-Endpunkt senden und dabei die Prozessdefinitions-ID angeben.
API-Format
POST /process-definitions/{DEFINITION_ID}/schedule:pause
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status-Code 200 mit Informationen zum Zeitplan zurück.
| code language-json |
|---|
|
Setzt den angegebenen Zeitplan fort resume-schedule
Sie können den Zeitplan für eine Prozessdefinition fortsetzen, indem Sie eine POST-Anfrage an den /process-definitions/{DEFINITION_ID}/schedule:resume-Endpunkt senden und dabei die Prozessdefinitions-ID angeben.
API-Format
POST /process-definitions/{DEFINITION_ID}/schedule:resume
{DEFINITION_ID}Anfrage
| code language-shell |
|---|
|
Antwort
Eine erfolgreiche Anfrage gibt den HTTP-Status-Code 200 mit Informationen zum Zeitplan zurück.
| code language-json |
|---|
|