Po wyzwoleniu elementu webhook na określony adres URL ładunku zostaje dostarczony ładunek. Każde zdarzenie dla konkretnego elementu webhook korzysta z podobnego schematu JSON zawierającego informacje odpowiednie dla obsługiwanego zdarzenia. W poniższych sekcjach zdefiniowano właściwości zawarte w ładunkach oraz przedstawiono przykładowe ładunki dla elementów webhook instytucji i usług.
Ładunki elementów webhook instytucji
W poniższej tabeli wymieniono właściwości zawarte w ładunkach elementów webhook instytucji, zwracające informacje o zmianach i aktualizacjach użytkowników, grup, elementów i ról w instytucji.
Właściwość | Opis |
---|---|
webhookName | Nazwa elementu webhook, który dostarczył ładunek. |
webhookId | Identyfikator elementu webhook, który dostarczył ładunek. |
portalURL | Adres URL portalu, w którym jest zarejestrowany element webhook. |
when | Czas dostarczenia ładunku. |
username | Użytkownik, który wyzwolił zdarzenie. |
userId | Identyfikator użytkownika, który wyzwolił zdarzenie. |
when | Czas wystąpienia zdarzenia. |
operation | Typ operacji wykonanej przez użytkownika. Na poniższej liście przedstawiono właściwości typu operacji zwracane w ładunku i powiązane z nimi operacje interfejsu Portal Directory API:
|
source | Typ elementu, na którym wykonano operację. Może to być items, group lub user. |
id | Identyfikator elementu źródłowego, na którym wykonano operację. |
properties | Dodatkowe właściwości powiązane z określonymi wyzwalaczami zdarzeń. Na poniższej liście przedstawiono dodatkowe właściwości zawarte w ładunku. Aby uzyskać więcej informacji o tym, które wyzwalacze zdarzeń zawierają dodatkowe właściwości, zapoznaj się z tematem Wyzwalacze zdarzeń, ewentualnie klikaj poniższe właściwości w celu uzyskania dodatkowych informacji o konkretnym wyzwalaczu i jego właściwościach. |
Przykład ładunku
Poniżej przedstawiono przykład ładunku elementu webhook instytucji, który jest wyzwalany po zaktualizowaniu określonej grupy:
{
"info": {
"webhookName": "Group monitoring",
"webhookId": "72fed926aeb74c9ca8a22aacddc6725a",
"portalURL": "https://orgURL/portal/",
"when": 1543192196521
},
"events": [
{
"username": "administrator",
"userId": "173dd04b69134bdf99c5000aad0b6298",
"when": 1543192196521,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}
Ładunki elementów webhook usług geoprzetwarzania
W poniższej tabeli wymieniono właściwości zawarte w ładunkach elementów webhook usług geoprzetwarzania, zwracające informacje o zmianach wprowadzonych w usługach geoprzetwarzania.
Właściwość | Opis |
---|---|
serviceType | Typ usługi, dla którego skonfigurowano element webhook. W przypadku elementów webhook usług obiektowych ta właściwość zwróci tylko GPServer. |
jobId | Identyfikator zadania usługi geoprzetwarzania. |
statusURL | Adres URL statusu zadania usługi geoprzetwarzania, który można sprawdzać w celu zwrócenia informacji o statusie zadania. |
name | Nazwa elementu webhook. |
taskName | Nazwa narzędzia geoprzetwarzania. |
folderName | Folder, w którym znajduje się usługa geoprzetwarzania. |
serviceName | Nazwa usługi geoprzetwarzania. |
eventType | Właściwość reprezentująca to, jak ukończono zadanie usługi geoprzetwarzania. Elementy webhook usług geoprzetwarzania nie subskrybują określonych wyzwalaczy zdarzeń. Zamiast tego te elementy webhook dostarczają ładunki po ukończeniu zadania usługi geoprzetwarzania. Te ładunki informują o tym, że zadanie zostało ukończone pomyślnie (esriJobSucceeded), niepomyślnie (esriJobFailed) lub zostało anulowane (esriJobCancelled). Wartości: esriJobSucceeded | esriJobFailed | esriJobCancelled |
when | Znacznik czasu (w formacie milisekund, jakie upłynęły od epoki) ukończenia zadania. |
Przykład ładunku
Poniżej przedstawiono przykład ładunku elementu webhook usługi geoprzetwarzania, który jest wyzwalany po ukończeniu zadania usługi geoprzetwarzania.
{
"serviceType": "GPServer",
"jobId": "jeccad3d9099d4e1591859fdb08f4d1eb",
"statusURL": https://machine.domain.com/webadaptor/rest/services/my_Service/GPServer/jobs/jeccad3d9099d4e1591859fdb08f4d1eb?f=pjson,
"name": "webhook1",
"taskName": "",
"folderName": "",
"serviceName": "my_Service",
"events": [
{
"eventType": "esriJobSucceeded",
"when": 1652458959318
}
]
}
Ładunki elementów webhook usług obiektowych
W poniższej tabeli wymieniono właściwości zawarte w ładunkach elementów webhook usług obiektowych, zwracające informacje o zmianach wprowadzonych w usługach obiektowych.
Właściwość | Opis |
---|---|
serviceType | Typ usługi, dla którego skonfigurowano element webhook. W przypadku elementów webhook usług obiektowych ta właściwość zwróci tylko FeatureServer. |
changesUrl | Adres URL punktu końcowego Wyodrębnij zmiany dla usługi. W ładunku zawarte są tylko wyzwalacz zdarzenia i czas wystąpienia, jednak możesz uzyskać dostęp do tego adresu URL, aby dowiedzieć się więcej o konkretnych zmianach, które miały miejsce podczas zdarzenia. |
id | Identyfikator elementu webhook, który dostarczył ładunek. |
folderName | Folder, w którym znajduje się usługa obiektowa. |
serviceName | Nazwa usługi obiektowej. |
eventType | Typ zdarzenia wykonywanego dla usługi obiektowej. Aby dowiedzieć się więcej o wartościach typów zmian, które można subskrybować podczas konfigurowania elementu webhook, zapoznaj się z tematem Wyzwalacze zdarzeń. Wartości: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged | FeaturesPosted |
when | Znacznik czasu (w formacie milisekund, jakie upłynęły od epoki) wystąpienia zdarzenia. |
Przykład ładunku
Poniżej przedstawiono przykład ładunku elementu webhook usługi obiektowej, który jest wyzwalany po zaktualizowaniu (FeaturesUpdated), usunięciu (FeaturesDeleted) i edytowaniu (FeaturesEdited) usługi obiektowej:
{
"serviceType": "FeatureServer",
"changesUrl": "https://machine.domain.com/webadaptor/rest/services/Hosted/my_Service/FeatureServer/extractChanges?serverGens=12942,13026",
"id": "84e17696-c9d8-43cc-9cf7-5aeb658db12b",
"folderName": "Hosted",
"serviceName": "my_Service",
"events": [
{
"eventType": "FeaturesUpdated",
"when": 1652459863334
},
{
"eventType": "FeaturesDeleted",
"when": 1652459863334
},
{
"eventType": "FeaturesEdited",
"when": 1652459863334
}
]
}