Endpunkt "Warnungsanmeldungen"
Mit dem Adobe Experience Platform-Abfrage-Service können Sie Warnhinweise für ungeplante und geplante Abfragen abonnieren. Warnhinweise können per E-Mail, über die Platform-Benutzeroberfläche oder über beide empfangen werden. Der Benachrichtigungsinhalt ist für Warnhinweise in der Plattform und für E-Mail-Warnungen identisch.
Erste Schritte
Die in diesem Handbuch verwendeten Endpunkte sind Teil der Adobe Experience Platform Query Service-API. Bevor Sie fortfahren, lesen Sie zunächst das Erste-Schritte-Handbuch , um wichtige Informationen zu erhalten, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich erforderlicher Kopfzeilen und Anweisungen zum Lesen von Beispiel-API-Aufrufen.
Warnungstypen alert-types
In der folgenden Tabelle werden die unterstützten Abfragewarnungstypen erläutert:
delay
oder Abfragelaufverzögerung wird derzeit nicht von der Query Service-API unterstützt. Dieser Warnhinweis benachrichtigt Sie, wenn das Ergebnis einer geplanten Abfrageausführung über einen festgelegten Schwellenwert hinaus verzögert wird. Um diesen Warnhinweis zu verwenden, müssen Sie eine benutzerdefinierte Zeit festlegen, zu der ein Warnhinweis Trigger wird, wenn die Abfrage für diese Dauer ausgeführt wird, ohne dass ein Abschluss oder ein Fehler auftritt. Informationen zum Festlegen dieses Warnhinweises in der Benutzeroberfläche finden Sie in der Dokumentation zu Abfragezeitplänen oder im Handbuch zur Inline-Abfrage von Aktionen .start
success
failed
quarantine
Die folgenden Warnhinweise gelten ohne Warnhinweis-Abonnement:
- Wenn ein Batch-Abfrageauftrag abgeschlossen wird, erhalten Benutzer eine Benachrichtigung.
- Wenn die Dauer eines Batch-Abfrageauftrags einen Schwellenwert überschreitet, wird ein Warnhinweis für die Person ausgelöst, die die Abfrage geplant hat.
Beispiel-API-Aufrufe
In den folgenden Abschnitten werden die verschiedenen API-Aufrufe beschrieben, die Sie mithilfe der Query Service-API ausführen können. Jeder Aufruf enthält das allgemeine API-Format, eine Beispielanfrage mit den erforderlichen Kopfzeilen und eine Beispielantwort.
Abrufen einer Liste aller Warnhinweise für eine Organisation und Sandbox get-list-of-org-alert-subs
Rufen Sie eine Liste aller Warnhinweise für eine Organisations-Sandbox ab, indem Sie eine GET-Anfrage an den /alert-subscriptions
-Endpunkt stellen.
API-Format
GET /alert-subscriptions
GET /alert-subscriptions?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
Abfrageparameter
Im Folgenden finden Sie eine Liste der verfügbaren Abfrageparameter zur Auflistung von Abfragen. Alle diese Parameter sind optional. Wenn Sie diesen Endpunkt ohne Parameter aufrufen, werden alle für Ihre Organisation verfügbaren Abfragen abgerufen.
orderby
created
und updated
. Hängen Sie dem Eigenschaftsnamen "+
"für aufsteigende und "-
"für absteigende Reihenfolge vor. Der Standardwert ist -created
. Beachten Sie, dass das Pluszeichen (+
) mit %2B
maskiert werden muss. Beispielsweise ist %2Bcreated
der Wert für eine aufsteigende erstellte Bestellung.pagesize
page
property
Filtern Sie die Ergebnisse nach ausgewählten Feldern. Die Filter müssen mit HTML-Escape-Zeichen versehen sein. Kommas dienen dazu, mehrere Filter zu kombinieren. Die folgenden Eigenschaften ermöglichen das Filtern:
- id
- assetId
- status
- alertType
Die unterstützten Operatoren sind ==
(gleich). Beispielsweise gibt id==6ebd9c2d-494d-425a-aa91-24033f3abeec
den Warnhinweis mit einer übereinstimmenden ID zurück.
Anfrage
curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 sowie das alerts
-Array mit Informationen zu Paginierung und Version zurückgegeben. Das alerts
-Array enthält Details zu allen Warnhinweisen für eine Organisation und eine bestimmte Sandbox. Pro Antwort stehen maximal drei Warnhinweise zur Verfügung. Im Antworttext ist ein Warnhinweis pro Warnhinweistyp enthalten.
alerts._links
-Objekt im alerts
-Array wurde zur Vereinfachung gekürzt. Ein vollständiges Beispiel für das alerts._links
-Objekt finden Sie in der Antwort auf die POST-Anfrage.{
"alerts": [
{
"assetId": "0ca168f4-e46b-4f7f-be6a-bdc386271b4a",
"id": "query_service_flow_run_start-dcf7b4be-ccd7-4c73-ae0c-a4bb34a40adada84",
"status": "enabled",
"alertType": "start",
"_links":{
"self": {…},
"subscribe": {…},
"patch_status": {…},
"get_list_of_subscribers_by_alert_type": {…},
"delete": {…}
}
},
{
"assetId": "0ca168f4-e46b-4f7f-be6a-bdc386271b4a",
"id": "query_service_flow_run_success-dcf7b4be-ccd7-4c73-ae0c-a4bb34a40adada84",
"status": "enabled",
"alertType": "success",
"_links":{
"self": {…},
"subscribe": {…},
"patch_status": {…},
"get_list_of_subscribers_by_alert_type": {…},
"delete": {…}
}
},
{
"assetId": "700d43d9-3b99-4d4c-8dbb-29c911c0e0df",
"id": "query_service_flow_run_start-75da972a-e859-47a5-934c-629904daa1ef",
"status": "enabled",
"alertType": "start",
"_links":{
"self": {…},
"subscribe": {…},
"patch_status": {…},
"get_list_of_subscribers_by_alert_type": {…},
"delete": {…}
}
}
],
"_page": {
"orderby": "-created",
"page": 1,
"count": 26,
"pageSize": 50
},
"_links": {
"next": {
"href": "https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2"
},
"prev": {
"href": "https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0"
}
},
"version": 1
}
alerts.assetId
alerts.id
alertType
und der Fluss-ID. Informationen zu den verfügbaren Warnhinweisen finden Sie in der Dokumentation zum Warnhinweis-Dashboard von Platform.alerts.status
enabled
, enabling
, disabled
und disabling
. Ein Warnhinweis wartet entweder aktiv auf die Ereignisse, wird für die zukünftige Verwendung angehalten, wobei alle relevanten Abonnenten und Einstellungen beibehalten werden, oder wechselt zwischen diesen Zuständen.alerts.alertType
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
alerts._links
_page
_links
Abrufen der Informationen zum Warnhinweis-Abonnement für eine bestimmte Abfrage- oder Zeitplan-ID retrieve-all-alert-subscriptions-by-id
Rufen Sie die Informationen zum Warnhinweis-Abonnement für eine bestimmte Abfrage- oder Zeitplan-ID ab, indem Sie eine GET-Anfrage an den /alert-subscriptions/{QUERY_ID}
- oder /alert-subscriptions/{SCHEDULE_ID}
-Endpunkt stellen.
API-Format
GET /alert-subscriptions/{QUERY_ID}
GET /alert-subscriptions/{SCHEDULE_ID}
{QUERY_ID}
{SCHEDULE_ID}
Anfrage
curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 sowie das alerts
-Array zurückgegeben, das Abonnementinformationen für die angegebene Abfrage- oder Zeitplan-ID enthält.
{
"alerts": [
{
"assetId": "6df22232-f427-4250-a4e1-43cd30990641",
"id": "query_service_flow_run_failure-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
"status": "enabled",
"alertType": "failure",
"subscriptions": {
"emailNotifications": [
"rrunner@adobe.com",
"jsnow@adobe.com",
"keverdeen@adobe.com"
],
"inContextNotifications": [
"rrunner@adobe.com",
"jsnow@adobe.com",
"keverdeen@adobe.com"
]
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
},
{
"assetId": "6df22232-f427-4250-a4e1-43cd30990641",
"id": "query_service_flow_run_start-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
"status": "enabled",
"alertType": "start",
"subscriptions": {
"emailNotifications": [
"rrunner@adobe.com"
],
"inContextNotifications": [
"rrunner@adobe.com"
]
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
}
]
}
assetId
id
alertType
und der Fluss-ID. Informationen zu den verfügbaren Warnhinweisen finden Sie in der Dokumentation zum Warnhinweis-Dashboard von Platform.status
enabled
, enabling
, disabled
und disabling
. Ein Warnhinweis wartet entweder aktiv auf die Ereignisse, wird für die zukünftige Verwendung angehalten, wobei alle relevanten Abonnenten und Einstellungen beibehalten werden, oder wechselt zwischen diesen Zuständen.alertType
Jeder Warnhinweis kann drei verschiedene Arten von Warnhinweistypen aufweisen. Dabei handelt es sich um:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.
subscriptions.emailNotifications
subscriptions.inContextNotifications
Abrufen von Informationen zu Warnhinweis-Abonnements für eine bestimmte Abfrage- oder Zeitplan-ID und einen Warnhinweistyp get-alert-info-by-id-and-alert-type
Rufen Sie Informationen zu Warnhinweis-Abonnements für eine bestimmte ID und einen bestimmten Warnhinweistyp ab, indem Sie eine GET-Anfrage an den /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
-Endpunkt stellen. Dies gilt für die ID von Abfragen und geplanten Abfragen.
API-Format
GET /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
GET /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
ALERT_TYPE
Diese Eigenschaft beschreibt den Ausführungsstatus von Abfragen, bei denen ein Warnhinweis von Triggern ausgegeben wird. Die Antwort enthält nur Informationen zum Warnhinweis-Abonnement für Warnhinweise dieses Typs. Jeder Warnhinweis kann drei verschiedene Arten von Warnhinweistypen aufweisen. Dabei handelt es sich um:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.
QUERY_ID
SCHEDULE_ID
Anfrage
curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start'' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Antwort
Bei einer erfolgreichen Antwort werden der HTTP-Status 200 sowie alle Warnhinweise zurückgegeben, die abonniert wurden. Dazu gehören die Warnhinweis-ID, der Typ des Warnhinweises, die Adobe-registrierten E-Mail-IDs des Abonnenten und der bevorzugte Benachrichtigungskanal.
{
"alerts": [
{
"assetId": "6df22232-f427-4250-a4e1-43cd30990641",
"id": "query_service_flow_run_success-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
"status": "enabled",
"alertType": "success",
"subscriptions": {
"emailNotifications": [
"rrunner@adobe.com",
"jsnow@adobe.com"
],
"inContextNotifications": [
"jsnow@adobe.com"
]
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
}
]
}
assetId
alertType
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
subscriptions
subscriptions.inContextNotifications
subscriptions.emailNotifications
Rufen Sie eine Liste aller Warnungen ab, die eine Person abonniert hat get-alert-subscription-list
Rufen Sie eine Liste aller Warnhinweise ab, die eine Person abonniert hat, indem Sie eine GET-Anfrage an den /alert-subscriptions/user-subscriptions/{EMAIL_ID}
-Endpunkt stellen. Die Antwort enthält den Namen des Warnhinweises, die IDs, den Status, den Typ des Warnhinweises und die Benachrichtigungskanäle.
API-Format
GET /alert-subscriptions/user-subscriptions/{EMAIL_ID}
{EMAIL_ID}
orderby
created
und updated
. Hängen Sie dem Eigenschaftsnamen "+
"für aufsteigende und "-
"für absteigende Reihenfolge vor. Der Standardwert ist -created
. Beachten Sie, dass das Pluszeichen (+
) mit %2B
maskiert werden muss. Beispielsweise ist %2Bcreated
der Wert für eine aufsteigende erstellte Bestellung.pagesize
page
property
Filtern Sie die Ergebnisse nach ausgewählten Feldern. Die Filter müssen mit HTML-Escape-Zeichen versehen sein. Kommas dienen dazu, mehrere Filter zu kombinieren. Die folgenden Eigenschaften ermöglichen das Filtern:
- id
- assetId
- status
- alertType
Die unterstützten Operatoren sind ==
(gleich). Beispielsweise gibt id==6ebd9c2d-494d-425a-aa91-24033f3abeec
den Warnhinweis mit einer übereinstimmenden ID zurück.
Anfrage
curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/user-subscriptions/rrunner@adobe.com' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 sowie das Array items
mit den Details zu den Warnhinweisen zurückgegeben, die mit der angegebenen emailId
abonniert wurden.
{
"items": [
{
"name": "query_service_flow_run_success-8f057161-b312-4274-b629-f346c7d15c1f",
"assetId": "39e65373-e47a-4feb-9e5a-dffa2f677bca",
"status": "enabled",
"alertType": "success",
"subscriptions": {
"inContextNotification": true,
"emailNotifications": true
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
},
{
"name": "query_service_flow_run_start-8f057161-b312-4274-b629-f346c7d15c1f",
"assetId": "39e65373-e47a-4feb-9e5a-dffa2f677bca",
"status": "enabled",
"alertType": "start",
"subscriptions": {
"inContextNotification": true,
"emailNotifications": true
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
}
], "_page": {
"orderby": "-created",
"page": 1,
"count": 26,
"pageSize": 50
},
"_links": {
"next": {
"href": "https://platform-int.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2"
},
"prev": {
"href": "https://platform-int.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0"
}
},
"version": 1
}
name
alertType
und der Fluss-ID. Informationen zu den verfügbaren Warnhinweisen finden Sie in der Dokumentation zum Warnhinweis-Dashboard von Platform.assetId
status
enabled
, enabling
, disabled
und disabling
. Ein Warnhinweis wartet entweder aktiv auf die Ereignisse, wird für die zukünftige Verwendung angehalten, wobei alle relevanten Abonnenten und Einstellungen beibehalten werden, oder wechselt zwischen diesen Zuständen.alertType
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
subscriptions
subscriptions.inContextNotifications
true
bestätigt, dass Warnhinweise über die Benutzeroberfläche bereitgestellt werden sollten. Der Wert false
stellt sicher, dass die Benutzenden nicht über diesen Kanal benachrichtigt werden.subscriptions.emailNotifications
true
bestätigt, dass Warnhinweise per E-Mail bereitgestellt werden sollten. Der Wert false
stellt sicher, dass Benutzende nicht über diesen Kanal benachrichtigt werden.Erstellen eines Warnhinweises und Abonnements von Benutzenden subscribe-users
Um einen Warnhinweis zu erstellen und Benutzende für den Empfang anzumelden, stellen Sie eine POST
-Anfrage an den /alert-subscriptions
-Endpunkt. Diese Anfrage verknüpft eine Abfrage mithilfe einer assetId
-Eigenschaft mit einem neu erstellten Warnhinweis und meldet Benutzende mithilfe von emailIds
für diesen Warnhinweis an.
API-Format
POST /alert-subscriptions
Anfrage
curl -X POST https://platform.adobe.io/data/foundation/query/alert-subscriptions
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '
{
"assetId": "a679dd0e-bcb2-4e69-a610-22d17ba98cac",
"alertType": "failure",
"subscriptions": {
"emailIds": [
"rrunner@adobe.com",
"jsnow@adobe.com"
],
"inContextNotifications": true,
"emailNotifications": true
}
}'
assetId
alertType
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
subscriptions
subscriptions.emailIds
subscriptions.inContextNotifications
true
bestätigt, dass Warnhinweise über die Benutzeroberfläche bereitgestellt werden sollten. Der Wert false
stellt sicher, dass die Benutzenden nicht über diesen Kanal benachrichtigt werden.subscriptions.emailNotifications
true
bestätigt, dass Warnhinweise per E-Mail bereitgestellt werden sollten. Der Wert false
stellt sicher, dass Benutzende nicht über diesen Kanal benachrichtigt werden.Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 202 (Akzeptiert) mit Details zum neu erstellten Warnhinweis zurückgegeben.
{
"assetId": "c4f67291-1161-4943-bc29-8736469bb928",
"id": "query_service_flow_run_failure-5f4cb942-b67c-4ea4-a90d-5b6245e60aca",
"alertType": "failure",
"subscriptions": {
"emailIds": [
"{USER_EMAIL_ID}"
],
"inContextNotifications": false,
"emailNotifications": true
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
"method": "GET"
},
"subscribe": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
"method": "POST",
"body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
},
"patch_status": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "PATCH",
"body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
},
"get_list_of_subscribers_by_alert_type": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
"method": "DELETE"
}
}
}
id
alertType
und der Fluss-ID. Informationen zu den verfügbaren Warnhinweisen finden Sie in der Dokumentation zum Warnhinweis-Dashboard von Platform._links
Aktivieren oder Deaktivieren eines Warnhinweises enable-or-disable-alert
Diese Anfrage verweist unter Verwendung einer Abfrage- oder Zeitplan-ID sowie eines Warnhinweistyps auf einen bestimmten Warnhinweis und aktualisiert den Warnhinweisstatus mit dem Statuswert enable
oder disable
. Sie können den Status eines Warnhinweises aktualisieren, indem Sie eine PATCH
-Anfrage an den /alert-subscriptions/{queryId}/{alertType}
- oder /alert-subscriptions/{scheduleId}/{alertType}
-Endpunkt stellen.
API-Format
PATCH /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
PATCH /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
ALERT_TYPE
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
Sie müssen den aktuellen Warnhinweistyp im Endpunkt-Namespace angeben, um ihn zu ändern.
QUERY_ID
SCHEDULE_ID
Anfrage
curl -X PATCH 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start'' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-d '{
"op": "replace",
"path" : "/status",
"value": "enable"
}'
op
replace
.path
/status
.value
status
-Wert des Warnhinweises geändert. Derzeit lauten die zulässigen Werte enable
oder disable
.Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Details zum Warnhinweisstatus, zum Typ und zur ID sowie zur Abfrage zurückgegeben, auf die er sich bezieht.
{
"id" : "query_service_flow_run_success-4422fc69-eaa7-464e-945b-63cfd435d3d1",
"assetId": "4422fc69-eaa7-464e-945b-63cfd435d3d1",
"alertType": "start",
"status": "enabled"
}
id
alertType
und der Fluss-ID. Informationen zu den verfügbaren Warnhinweisen finden Sie in der Dokumentation zum Warnhinweis-Dashboard von Platform.assetId
alertType
Jeder Warnhinweis kann drei verschiedene Arten von Warnhinweistypen aufweisen. Dabei handelt es sich um:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.
status
enabled
, enabling
, disabled
und disabling
. Ein Warnhinweis wartet entweder aktiv auf die Ereignisse, wird für die zukünftige Verwendung angehalten, wobei alle relevanten Abonnenten und Einstellungen beibehalten werden, oder wechselt zwischen diesen Zuständen.Löschen des Warnhinweises für eine bestimmte Abfrage und einen bestimmten Warnhinweistyp delete-alert-info-by-id-and-alert-type
Löschen Sie einen Warnhinweis für eine bestimmte Abfrage- oder Zeitplan-ID und einen Warnhinweistyp, indem Sie eine DELETE-Anfrage an den Endpunkt /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
oder /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
stellen.
DELETE /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
DELETE /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
ALERT_TYPE
Der Typ des Warnhinweises. Für geplante Abfragen stehen fünf Warnhinweisstatus zur Verfügung, obwohl nur vier Warnhinweisstatus für Ad-hoc-Abfragen verfügbar sind. Der quarantine
-Warnhinweis ist nur für geplante Abfragen verfügbar. Außerdem können Sie den delay
-Warnhinweis nur über die Platform-Benutzeroberfläche festlegen. Aus diesem Grund wird hier delay
nicht beschrieben. Die verfügbaren Warnhinweise sind:
start
: Benachrichtigt Benutzende, wenn die Ausführung der Abfrage begonnen hat.success
: Benachrichtigt Benutzende, wenn die Abfrage abgeschlossen ist.failure
: Benachrichtigt Benutzende, wenn die Abfrage fehlschlägt.quarantine
: Wird aktiviert, wenn eine geplante Abfrage unter Quarantäne gestellt wird.
Die DELETE-Anfrage gilt nur für den jeweils angegebenen Warnhinweistyp.
QUERY_ID
SCHEDULE_ID
Anfrage
curl -X DELETE 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 sowie eine Bestätigungsmeldung zurückgegeben, die die Asset-ID und den Warnhinweistyp des gelöschten Warnhinweises enthält.
{
"message": "Alert Deleted Successfully for assetId: 6df22232-f427-4250-a4e1-43cd30990641 and alertType: success",
"statusCode": 200
}
Nächste Schritte
In diesem Handbuch wurde die Verwendung des /alert-subscriptions
-Endpunkts in der Abfrage-Service-API behandelt. Nachdem Sie dieses Handbuch gelesen haben, wissen Sie nun besser, wie Sie einen Warnhinweis für eine Abfrage erstellen, Benutzende für den Warnhinweis abonnieren, welche Arten von Warnhinweisen verfügbar sind und wie Sie Informationen zum Warnhinweis-Abonnement abrufen, aktualisieren und löschen können.
Weitere Informationen zu anderen verfügbaren Funktionen und Vorgängen finden Sie im Handbuch zur Abfrage-Service-API.