DokumentationExperience PlatformAnvändarhandbok om Query Service

Slutpunkt för aviseringsprenumerationer

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Utvecklare

Med Adobe Experience Platform Query Service kan du prenumerera på aviseringar för både ad hoc-frågor och schemalagda frågor. Varningar kan tas emot via e-post, i användargränssnittet för plattformen eller båda. Meddelandeinnehållet är detsamma för varningar på plattformen och e-postvarningar.

Kom igång

Slutpunkterna som används i den här guiden ingår i Adobe Experience Platform Query Service API. Innan du fortsätter bör du läsa kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive nödvändiga rubriker och hur du läser exempel-API-anrop.

IMPORTANT
Om du vill få e-postaviseringar måste du först aktivera den här inställningen i användargränssnittet. I dokumentationen finns instruktioner om hur du aktiverar e-postaviseringar.

Aviseringstyper alert-types

Tabellen nedan förklarar vilka frågeartikeltyper som stöds:

IMPORTANT
Varningstypen delay eller Query Run Delay stöds för närvarande inte av API:t för frågetjänsten. Den här varningen meddelar dig om resultatet av en schemalagd frågekörning är försenat över ett angivet tröskelvärde. Om du vill använda den här varningen måste du ange en anpassad tid som utlöser en varning när frågan körs för den tiden utan att slutföras eller misslyckas. Mer information om hur du anger den här aviseringen i användargränssnittet finns i dokumentationen för frågescheman eller i handboken om infogade frågeåtgärder.
Aviseringstyp
Beskrivning
start
Den här varningen meddelar dig när en schemalagd frågekörning initieras eller börjar bearbetas.
success
Den här varningen informerar dig när en schemalagd frågekörning har slutförts, vilket anger att frågan har körts utan fel.
failed
Den här varningen utlöses när en schemalagd frågekörning påträffar ett fel eller misslyckas med att köras. Det hjälper er att snabbt identifiera och åtgärda problem.
quarantine
Den här varningen aktiveras när en schemalagd frågekörning sätts i karantän. När frågor registreras i karantänfunktionen, placeras automatiskt en Quarantined-status i en schemalagd fråga som misslyckas tio på varandra följande körningar. De måste sedan ingripa innan fler avrättningar kan utföras.
NOTE
Alla frågor som inte är SELECT-frågor har stöd för aviseringsprenumerationer och du behöver inte vara frågeskapare för att prenumerera på en avisering. Andra användare kan även registrera sig för varningar om en fråga som de inte har skapat.

Följande aviseringar gäller utan en aviseringsprenumeration:

  • När ett batchfrågejobb har slutförts får användarna ett meddelande.
  • När varaktigheten för ett batchfrågejobb överstiger ett tröskelvärde, utlöses en varning till den person som schemalagt frågan.
NOTE
Frågor som används för testning kan uteslutas från dessa aviseringar om de är korrekt konfigurerade.

Exempel på API-anrop

Följande avsnitt går igenom de olika API-anrop du kan göra med hjälp av API:t för frågetjänsten. Varje anrop innehåller det allmänna API-formatet, en exempelbegäran med obligatoriska rubriker och ett exempelsvar.

Hämta en lista över alla aviseringar för en organisation och en sandlåda get-list-of-org-alert-subs

Hämta en lista över alla aviseringar för en organisationssandlåda genom att göra en GET-begäran till slutpunkten /alert-subscriptions.

API-format

GET /alert-subscriptions
GET /alert-subscriptions?{QUERY_PARAMETERS}
Egenskap
Beskrivning
{QUERY_PARAMETERS}
(Valfritt) Parametrar har lagts till i den begärda sökvägen som konfigurerar resultaten som returneras i svaret. Flera parametrar kan inkluderas, avgränsade med et-tecken (&). De tillgängliga parametrarna visas nedan.

Frågeparametrar

Här följer en lista med tillgängliga frågeparametrar för att lista frågor. Alla dessa parametrar är valfria. Om du anropar den här slutpunkten utan parametrar hämtas alla frågor som är tillgängliga för din organisation.

Parameter
Beskrivning
orderby
Fältet som anger resultatordningen. De fält som stöds är created och updated. Lägg till egenskapsnamnet med + för stigande och - för fallande ordning. Standardvärdet är -created. Observera att plustecknet (+) måste föregås av %2B. %2Bcreated är till exempel värdet för en stigande skapad order.
pagesize
Använd den här parametern för att styra antalet poster som du vill hämta från API-anropet per sida. Standardgränsen är den maximala mängden på 50 poster per sida.
page
Ange sidnumret för de returnerade resultat som du vill se posterna för.
property

Filtrera resultaten baserat på valda fält. Filtren måste vara HTML escape. Kommandon används för att kombinera flera uppsättningar filter. Följande egenskaper tillåter filtrering:

  • id
  • assetId
  • status
  • alertType

Operatorer som stöds är == (lika med). id==6ebd9c2d-494d-425a-aa91-24033f3abeec returnerar till exempel aviseringen med ett matchande ID.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP 200-status och alerts-arrayen med sidnumrering och versionsinformation. Arrayen alerts innehåller information om alla aviseringar för en organisation och en viss sandlåda. Det finns högst tre larm tillgängliga per svar, en varning per varningstyp finns i svarsorganet.

NOTE
Objektet alerts._links i arrayen alerts har trunkerats av utrymmesskäl. Ett fullständigt exempel på alerts._links-objektet finns i svaret på POSTEN.
{
    "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
}
Egenskap
Beskrivning
alerts.assetId
Det fråge-ID som associerade aviseringen med en viss fråga.
alerts.id
Namnet på aviseringen. Det här namnet genereras av larmtjänsten och används på larmpanelen. Varningsnamnet består av mappen som lagrar varningen, alertType och flödes-ID:t. Information om de tillgängliga aviseringarna finns i dokumentationen för kontrollpanelen Plattformsvarningar.
alerts.status
Varningen har fyra statusvärden: enabled, enabling, disabled och disabling. En varning lyssnar antingen aktivt efter händelser, pausas för framtida bruk samtidigt som alla relevanta prenumeranter och inställningar behålls, eller så sker en övergång mellan dessa lägen.
alerts.alertType

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.
alerts._links
Tillhandahåller information om tillgängliga metoder och slutpunkter som kan användas för att hämta, uppdatera, redigera eller ta bort information om detta varnings-ID.
_page
Objektet innehåller egenskaper som beskriver ordningen, storleken, det totala antalet sidor och den aktuella sidan.
_links
Objektet innehåller URI-referenser som kan användas för att hämta nästa eller föregående sida med resurser.

Hämta aviseringsprenumerationsinformation för en viss fråga eller ett visst schema-ID retrieve-all-alert-subscriptions-by-id

Hämta aviseringsprenumerationsinformationen för ett visst fråge-ID eller schema-ID genom att göra en GET-förfrågan till /alert-subscriptions/{QUERY_ID} eller /alert-subscriptions/{SCHEDULE_ID}-slutpunkten.

API-format

GET /alert-subscriptions/{QUERY_ID}
GET /alert-subscriptions/{SCHEDULE_ID}
Parameter
Beskrivning
{QUERY_ID}
ID:t för frågan som du vill returnera prenumerationsinformationen för.
{SCHEDULE_ID}
ID:t för den schemalagda fråga som du vill returnera prenumerationsinformationen för.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP-statusen 200 och arrayen alerts som innehåller prenumerationsinformation för den angivna frågan eller det angivna schema-ID:t.

{
    "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"
                }
            }
        }
    ]
}
Egenskap
Beskrivning
assetId
Varningen är kopplad till detta ID. ID:t kan vara antingen ett fråge-ID eller ett schema-ID.
id
Namnet på aviseringen. Det här namnet genereras av larmtjänsten och används på larmpanelen. Varningsnamnet består av mappen som lagrar varningen, alertType och flödes-ID:t. Information om de tillgängliga aviseringarna finns i dokumentationen för kontrollpanelen Plattformsvarningar.
status
Varningen har fyra statusvärden: enabled, enabling, disabled och disabling. En varning lyssnar antingen aktivt efter händelser, pausas för framtida bruk samtidigt som alla relevanta prenumeranter och inställningar behålls, eller så sker en övergång mellan dessa lägen.
alertType

Varje varning kan ha tre olika varningstyper. De är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
subscriptions.emailNotifications
En matris med Adobe-registrerade e-postadresser för användare som har prenumererat på att ta emot e-postmeddelanden för aviseringen.
subscriptions.inContextNotifications
En array med Adobe-registrerade e-postadresser för användare som har prenumererat på gränssnittsmeddelanden för aviseringen.

Hämta aviseringsprenumerationsinformation för en viss fråga eller schema-ID och aviseringstyp get-alert-info-by-id-and-alert-type

Hämta aviseringsprenumerationsinformationen för ett visst ID och en viss aviseringstyp genom att göra en GET-förfrågan till slutpunkten /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}. Detta gäller för både fråge- och schemalagda fråge-ID.

API-format

GET /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
GET /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
Parametrar
Beskrivning
ALERT_TYPE

This property describes the state of query execution that trigger an alert. Svaret kommer endast att innehålla prenumerationsinformation för aviseringar av den här typen. Varje varning kan ha tre olika varningstyper. De är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
QUERY_ID
Den unika identifieraren för frågan som ska uppdateras.
SCHEDULE_ID
Den unika identifieraren för den schemalagda frågan som ska uppdateras.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP-statusen 200 och alla aviseringar som prenumererar på. Detta inkluderar aviserings-ID, typ av avisering, prenumerantens Adobe-registrerade e-post-ID och deras föredragna meddelandekanal.

{
    "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"
                }
            }
        }
    ]
}
Egenskap
Beskrivning
assetId
Det fråge-ID som associerade aviseringen med en viss fråga.
alertType

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.
subscriptions
Ett objekt som används för att skicka registrerade e-post-ID:n för Adobe som är kopplade till aviseringarna och de kanaler som användarna kommer att ta emot aviseringarna i.
subscriptions.inContextNotifications
En array med Adobe-registrerade e-postadresser för användare som har prenumererat på gränssnittsmeddelanden för aviseringen.
subscriptions.emailNotifications
En matris med Adobe-registrerade e-postadresser för användare som har prenumererat på att ta emot e-postmeddelanden för aviseringen.

Hämta en lista med alla aviseringar som en användare prenumererar på get-alert-subscription-list

Hämta en lista över alla aviseringar som en användare prenumererar på genom att göra en GET-förfrågan till slutpunkten /alert-subscriptions/user-subscriptions/{EMAIL_ID}. Svaret innehåller varningsnamn, ID:n, status, varningstyp och meddelandekanaler.

API-format

GET /alert-subscriptions/user-subscriptions/{EMAIL_ID}
Parametrar
Beskrivning
{EMAIL_ID}
En e-postadress som är registrerad för ett Adobe-konto används för att identifiera de användare som prenumererar på aviseringar.
orderby
Fältet som anger resultatordningen. De fält som stöds är created och updated. Lägg till egenskapsnamnet med + för stigande och - för fallande ordning. Standardvärdet är -created. Observera att plustecknet (+) måste föregås av %2B. %2Bcreated är till exempel värdet för en stigande skapad order.
pagesize
Använd den här parametern för att styra antalet poster som du vill hämta från API-anropet per sida. Standardgränsen är den maximala mängden på 50 poster per sida.
page
Ange sidnumret för de returnerade resultat som du vill se posterna för.
property

Filtrera resultaten baserat på valda fält. Filtren måste vara HTML escape. Kommandon används för att kombinera flera uppsättningar filter. Följande egenskaper tillåter filtrering:

  • id
  • assetId
  • status
  • alertType

Operatorer som stöds är == (lika med). id==6ebd9c2d-494d-425a-aa91-24033f3abeec returnerar till exempel aviseringen med ett matchande ID.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP-status 200 och items-arrayen med information om de aviseringar som prenumereras av emailId som anges.

{
    "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
}
Egenskap
Beskrivning
name
Namnet på aviseringen. Det här namnet genereras av larmtjänsten och används på larmpanelen. Varningsnamnet består av mappen som lagrar varningen, alertType och flödes-ID:t. Information om de tillgängliga aviseringarna finns i dokumentationen för kontrollpanelen Plattformsvarningar.
assetId
Det fråge-ID som associerade aviseringen med en viss fråga.
status
Varningen har fyra statusvärden: enabled, enabling, disabled och disabling. En varning lyssnar antingen aktivt efter händelser, pausas för framtida bruk samtidigt som alla relevanta prenumeranter och inställningar behålls, eller så sker en övergång mellan dessa lägen.
alertType

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.
subscriptions
Ett objekt som används för att skicka registrerade e-post-ID:n för Adobe som är kopplade till aviseringarna och de kanaler som användarna kommer att ta emot aviseringarna i.
subscriptions.inContextNotifications
Ett booleskt värde som avgör hur användarna får varningsmeddelanden. Ett true-värde bekräftar att aviseringar ska skickas via användargränssnittet. Ett false-värde säkerställer att användarna inte meddelas via den kanalen.
subscriptions.emailNotifications
Ett booleskt värde som avgör hur användarna får varningsmeddelanden. Ett true-värde bekräftar att aviseringar ska skickas via e-post. Ett false-värde säkerställer att användarna inte meddelas via den kanalen.

Skapa en avisering och prenumerera subscribe-users

Om du vill skapa en avisering och prenumerera på en användare som ska ta emot den, gör du en POST-begäran till /alert-subscriptions-slutpunkten. Den här begäran kopplar en fråga till en nyligen skapad avisering med en assetId-egenskap och prenumererar användare på aviseringar för den frågan med hjälp av emailIds.

IMPORTANT
Du kan skicka upp till fem Adobe-registrerade e-post-ID:n i en enda begäran. Om du vill prenumerera för fler än fem användare på en avisering måste du göra ytterligare förfrågningar.

API-format

POST /alert-subscriptions

Begäran

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
    }
}'
Egenskap
Beskrivning
assetId
Varningen är kopplad till detta ID. ID:t kan vara antingen ett fråge-ID eller ett schema-ID.
alertType

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.
subscriptions
Ett objekt som används för att skicka registrerade e-post-ID:n för Adobe som är kopplade till aviseringarna och de kanaler som användarna kommer att ta emot aviseringarna i.
subscriptions.emailIds
En matris med e-postadresser som identifierar de användare som ska ta emot aviseringarna. E-postadresserna måste registreras på ett Adobe-konto.
subscriptions.inContextNotifications
Ett booleskt värde som avgör hur användarna får varningsmeddelanden. Ett true-värde bekräftar att aviseringar ska skickas via användargränssnittet. Ett false-värde säkerställer att användarna inte meddelas via den kanalen.
subscriptions.emailNotifications
Ett booleskt värde som avgör hur användarna får varningsmeddelanden. Ett true-värde bekräftar att aviseringar ska skickas via e-post. Ett false-värde säkerställer att användarna inte meddelas via den kanalen.

Svar

Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med information om din nyligen skapade avisering.

{
    "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"
        }
    }
}
Egenskap
Beskrivning
id
Namnet på aviseringen. Det här namnet genereras av larmtjänsten och används på larmpanelen. Varningsnamnet består av mappen som lagrar varningen, alertType och flödes-ID:t. Information om de tillgängliga aviseringarna finns i dokumentationen för kontrollpanelen Plattformsvarningar.
_links
Tillhandahåller information om tillgängliga metoder och slutpunkter som kan användas för att hämta, uppdatera, redigera eller ta bort information om detta varnings-ID.

Aktivera eller inaktivera en varning enable-or-disable-alert

Den här begäran refererar till en viss avisering med en fråga eller ett schema-ID och en aviseringstyp och uppdaterar aviseringsstatusen till antingen enable eller disable. Du kan uppdatera status för en avisering genom att göra en PATCH-begäran till /alert-subscriptions/{queryId}/{alertType}- eller /alert-subscriptions/{scheduleId}/{alertType}-slutpunkten.

API-format

PATCH /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
PATCH /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
Parametrar
Beskrivning
ALERT_TYPE

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.

Du måste ange den aktuella varningstypen i slutpunktens namnutrymme för att kunna ändra den.

QUERY_ID
Den unika identifieraren för frågan som ska uppdateras.
SCHEDULE_ID
Den unika identifieraren för den schemalagda frågan som ska uppdateras.

Begäran

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"
      }'
Egenskap
Beskrivning
op
Den åtgärd som ska utföras. För närvarande är det enda godkända värdet replace.
path
Det här värdet relaterar till namnutrymmet i slutpunkten. För närvarande är det enda godkända värdet /status.
value
I en slutförd PATCH-begäran ändras aviseringens status-värde. Godkända värden är enable eller disable.

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om aviseringsstatus, typ och ID samt den fråga det är relaterat till.

{
    "id" : "query_service_flow_run_success-4422fc69-eaa7-464e-945b-63cfd435d3d1",
    "assetId": "4422fc69-eaa7-464e-945b-63cfd435d3d1",
    "alertType": "start",
    "status": "enabled"
}
Egenskap
Beskrivning
id
Namnet på aviseringen. Det här namnet genereras av larmtjänsten och används på larmpanelen. Varningsnamnet består av mappen som lagrar varningen, alertType och flödes-ID:t. Information om de tillgängliga aviseringarna finns i dokumentationen för kontrollpanelen Plattformsvarningar.
assetId
Varningen är kopplad till detta ID. ID:t kan vara antingen ett fråge-ID eller ett schema-ID.
alertType

Varje varning kan ha tre olika varningstyper. De är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
status
Varningen har fyra statusvärden: enabled, enabling, disabled och disabling. En varning lyssnar antingen aktivt efter händelser, pausas för framtida bruk samtidigt som alla relevanta prenumeranter och inställningar behålls, eller så sker en övergång mellan dessa lägen.

Ta bort aviseringen för en viss fråga och larmtyp delete-alert-info-by-id-and-alert-type

Ta bort en avisering för en viss fråga eller ett visst schema-ID och en aviseringstyp genom att göra en DELETE-begäran till slutpunkten /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE} eller /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}.

DELETE /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
DELETE /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
Parametrar
Beskrivning
ALERT_TYPE

Typ av varning. Det finns fem varningslägen tillgängliga för schemalagda frågor, men det finns bara fyra varningslägen tillgängliga för ad hoc-frågor. Aviseringen quarantine är bara tillgänglig för schemalagda frågor. Du kan bara ange aviseringen delay från plattformsgränssnittet. Därför beskrivs inte delay här. Tillgängliga aviseringar är:

  • start: Meddelar en användare när frågekörningen har startat.
  • success: Meddelar användaren när frågan har slutförts.
  • failure: Meddelar användaren om frågan misslyckas.
  • quarantine: Aktiveras när en schemalagd frågekörning sätts i karantän.

Begäran från DELETE gäller endast den särskilda larmtypen.

QUERY_ID
Den unika identifieraren för frågan som ska uppdateras.
SCHEDULE_ID
Den unika identifieraren för den schemalagda frågan som ska uppdateras.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP 200-status och ett bekräftelsemeddelande som innehåller resurs-ID:t och varningstypen för den borttagna varningen.

{
"message": "Alert Deleted Successfully for assetId: 6df22232-f427-4250-a4e1-43cd30990641 and alertType: success",
"statusCode": 200
}

Nästa steg

Den här guiden beskriver användningen av slutpunkten /alert-subscriptions i API:t för frågetjänsten. När du har läst den här guiden får du nu en bättre förståelse för hur du skapar en avisering för en fråga, prenumererar på aviseringar, vilka typer av aviseringar som är tillgängliga och hur du kan hämta, uppdatera och ta bort aviseringsprenumerationsinformation.

Se API-handboken för frågetjänsten om du vill veta mer om andra tillgängliga funktioner och åtgärder.

recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb