Podczas tworzenia elementu webhook możesz subskrybować określone wyzwalacze zdarzeń powiązane z operacjami interfejsu API, które będą wywoływać element webhook i dostarczać informacje o zdarzeniu za pośrednictwem ładunku. W poniższych sekcjach przedstawiono dostępne wyzwalacze zdarzeń i powiązane z nimi identyfikatory URI lub wartości typu zmian dla elementów webhook usług obiektowych i instytucji.
Notatka:
W przeciwieństwie do elementów webhook instytucji i usług obiektowych elementy webhook usług geoprzetwarzania nie mają wyzwalaczy zdarzeń zdefiniowanych przez użytkownika. Elementy webhook usług geoprzetwarzania dostarczają ładunki po ukończeniu zadania geoprzetwarzania. Aby uzyskać więcej informacji na temat ładunków dostarczanych dla usług geoprzetwarzania, zapoznaj się z tematem Ładunki.
Zdarzenia elementów instytucji
Poniższa tabela zawiera listę wyzwalaczy zdarzeń dla elementów instytucji, w tym map internetowych, aplikacji internetowych, warstw, pakietów i dokumentów PDF:
Wyzwalacz zdarzenia | URI |
---|---|
Wszystkie zdarzenia wyzwalacza dla wszystkich elementów | /items |
Dowolny element zostanie dodany do portalu | /items/add |
Dowolny element zostanie usunięty | /items/delete |
Dowolny element zostanie zaktualizowany | /items/update |
Dowolny element zostanie przeniesiony lub nastąpi zmiana jego właściciela | /items/move |
Dowolny element zostanie opublikowany | /items/publish |
Dowolny element zostanie udostępniony | /items/share |
Dowolny element przestanie być udostępniany | /items/unshare |
Nastąpi ponowne przypisanie prawa własności do dowolnego elementu | /items/reassign |
Komentarz jest dodawany do każdego elementu | /items/addComment |
Komentarz jest usuwany z dowolnego elementu | /items/deleteComment |
Komentarz jest aktualizowany dla każdego elementu | /items/updateComment |
Wszystkie zdarzenia wyzwalacza dla konkretnego elementu | /items/<itemID> |
Konkretny element zostanie usunięty | /items/<itemID>/delete |
Zostaną zaktualizowane właściwości konkretnego elementu Notatka:Właściwości elementu, które mogą zostać zaktualizowane, zależą od typów elementu. Istnieją unikalne działania, które wyzwalają operację Update (aktualizacja). Jeśli na przykład element jest mapą internetową, aktualizacja znacznika, skonfigurowanie okna podręcznego lub zmiana mapy bazowej będą zdarzeniami aktualizacji wyzwalającymi element webhook. | /items/<itemID>/update |
Zostanie zmieniony właściciel konkretnego elementu lub ten element zostanie przeniesiony | /items/<itemID>/move |
Konkretny element zostanie opublikowany | /items/<itemID>/publish |
Konkretny element zostanie udostępniony | /items/<itemID>/share |
Konkretny element przestanie być udostępniany | /items/<itemID>/unshare |
Nastąpi ponowne przypisanie prawa własności do konkretnego elementu | /items/<itemID>/reassign |
Komentarz jest dodawany do określonego elementu | /items/<itemId>/addComment |
Komentarz jest usuwany z określonego elementu | /items/<itemId>/deleteComment |
Komentarz jest aktualizowany dla określonego elementu | /items/<itemId>/updateComment |
Właściwości wyzwalacza zdarzenia elementu
Niektóre wyzwalacze zdarzeń dla elementów instytucji zwracają w ładunkach dodatkowe właściwości. W poniższych sekcjach przedstawiono dodatkowe właściwości ładunku dla tych wyzwalaczy.
Konkretny element zostanie udostępniony
Elementy webhook, które subskrybują wyzwalacz zdarzenia /items/<itemID>/share, mają w ładunku właściwość sharedToGroups. Właściwość sharedToGroups określa sposób udostępnienia elementu. Jeśli element został udostępniony grupie, obiekt JSON properties zawiera identyfikator każdej grupy, której element został udostępniony. Jeśli element został udostępniony instytucji jako całości, obiekt zawiera opcję Organization. Jeśli element został udostępniony publicznie, obiekt zawiera opcję Everyone. Poniższy przykład ilustruje udostępnienie elementu określonym grupom, a także udostępnienie elementu zarówno publicznie, jak i określonym grupom.
Przykłady
//groupIDs
"properties": {
"sharedToGroups": [
"ecd6646698b24180904e4888d5eaede3",
"2dff15c514ad4f04b291e304e24a524b"
]
}
//Everyone and groupIDs
"properties": {
"sharedToGroups": [
"Everyone",
"4adc30bb03054812a846fa592de105de",
"a4e6e37e2f7d4bb5b64d587c91d39a2c"
]
}
Nastąpi ponowne przypisanie prawa własności do dowolnego elementu
Elementy webhook, które subskrybują wyzwalacz zdarzenia /items/reassign, mają w ładunku właściwość reassignedTo. Właściwość reassignedTo określa nowego użytkownika, do którego ponownie przypisano element lub grupę, zwracając nazwę użytkownika nowego właściciela w obiekcie JSON properties.
Przykład
"properties": {
"reassignedTo": ["newOwner"]
}
Konkretny element przestanie być udostępniany
Elementy webhook, które subskrybują wyzwalacz zdarzenia /items/<itemID>/unshare, mają w ładunku właściwość unsharedFromGroups. Właściwość unsharedFromGroups określa sposób zaprzestania udostępniania elementu. Jeśli zaprzestano udostępniania elementu grupie, obiekt JSON properties zawiera identyfikator każdej grupy, dla której zaprzestano udostępniania elementu. Jeśli zaprzestano udostępniania elementu instytucji jako całości, obiekt zawiera opcję Organization. Jeśli zaprzestano udostępniania elementu publicznie, obiekt zawiera opcję Everyone. W poniższych przykładowych właściwościach pokazano zaprzestanie udostępniania elementu publicznie, a także zaprzestanie udostępniania elementu określonej grupie.
Przykłady
//Everyone
"properties": {
"unsharedFromGroups": ["Everyone"]
}
//groupID
"properties": {
"unsharedFromGroups": [
"4adc30bb03054812a846fa592de105de"
]
}
Nastąpi ponowne przypisanie prawa własności do konkretnego elementu
Elementy webhook, które subskrybują wyzwalacz zdarzenia /items/<itemID>/reassign, mają w ładunku właściwość reassignedTo. Właściwość reassignedTo określa nowego użytkownika, do którego przypisano element lub grupę, zwracając nazwę użytkownika nowego właściciela w obiekcie JSON properties.
Przykład
"properties": {
"reassignedTo": ["newOwner"]
}
Zdarzenia grup instytucji
W poniższej tabeli podano wyzwalacze zdarzeń dla grup instytucji:
Wyzwalacz zdarzenia | URI |
---|---|
Wszystkie zdarzenia wyzwalacza dla wszystkich grup | /groups |
Grupa zostanie dodana | /groups/add |
Dowolna grupa zostanie zaktualizowana | /groups/update |
Dowolna grupa zostanie usunięta | /groups/delete |
Dla dowolnej grupy zostanie włączona opcja Ochrona przed usunięciem | /groups/protect |
Dla dowolnej grupy zostanie wyłączona opcja Ochrona przed usunięciem | /groups/unprotect |
Do dowolnej grupy zostanie zaproszony użytkownik | /groups/invite |
Do dowolnej grupy zostanie dodany użytkownik | /groups/addUsers |
Z dowolnej grupy zostanie usunięty użytkownik | /groups/removeUsers |
W dowolnej grupie zostanie zaktualizowana rola użytkownika | /groups/updateUsers |
Nastąpi ponowne przypisanie prawa własności dowolnej grupy | /groups/reassign |
Element jest udostępniany dowolnej grupie | /groups/itemShare |
Element przestaje być udostępniany jakiejkolwiek grupie | /groups/itemUnshare |
Użytkownik przesyła prośbę o dołączenie do dowolnej grupy | /groups/requestJoin |
Wszystkie zdarzenia wyzwalacza dla konkretnej grupy | /groups/<groupID> |
Konkretna grupa zostanie zaktualizowana Notatka:Wszystkie zmiany ogólne wprowadzone w ustawieniach grupy stanowią aktualizację. Na przykład zmiana dostępu grupy wyzwoli zdarzenie aktualizacji. | /groups/<groupID>/update |
Konkretna grupa zostanie usunięta | /groups/<groupID>/delete |
Dla konkretnej grupy zostanie włączona opcja Ochrona przed usunięciem | /groups/<groupID>/protect |
Dla konkretnej grupy zostanie wyłączona opcja Ochrona przed usunięciem | /groups/<groupID>/unprotect |
Do konkretnej grupy zostanie zaproszony użytkownik | /groups/<groupID>/invite |
Do konkretnej grupy zostanie dodany użytkownik | /groups/<groupID>/addUsers |
Z konkretnej grupy zostanie usunięty użytkownik | /groups/<groupID>/removeUsers |
W konkretnej grupie zostanie zaktualizowana rola użytkownika | /groups/<groupID>/updateUsers |
Nastąpi ponowne przypisanie prawa własności konkretnej grupy | /groups/<groupID>/reassign |
Element zostanie udostępniony grupie | /groups/<groupID>/itemShare |
Element przestanie być udostępniany konkretnej grupie | /groups/<groupID>/itemUnshare |
Użytkownik prosi o dołączenie do określonej grupy | /groups/<groupId>/requestJoin |
Właściwości wyzwalacza zdarzenia grupy
Niektóre wyzwalacze zdarzeń dla grup instytucji zwracają w ładunkach dodatkowe właściwości. W poniższych sekcjach przedstawiono dodatkowe właściwości ładunku dla tych wyzwalaczy.
Do konkretnej grupy zostanie zaproszony użytkownik
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/invite, mają w ładunku właściwość invitedUserNames. Właściwość invitedUserNames określa nazwy użytkowników zaproszonych do grupy, zwracając listę nazw użytkowników w obiekcie JSON properties.
Przykład
"properties": {
"invitedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Do konkretnej grupy zostanie dodany użytkownik
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/addUsers, mają w ładunku właściwość addedUserNames. Właściwość addedUserNames określa nazwy użytkowników dodanych do grupy, zwracając listę nazw użytkowników w obiekcie JSON properties.
Przykład
"properties": {
"addedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Z konkretnej grupy zostanie usunięty użytkownik
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/removeUsers, mają w ładunku właściwość removeUserNames. Właściwość removeUserNames określa nazwy użytkowników usuniętych z grupy, zwracając listę nazw użytkowników w obiekcie JSON properties.
Przykład
"properties": {
"removedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
W konkretnej grupie zostanie zaktualizowana rola użytkownika
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/updateUsers, mają w ładunku właściwość updateUserNames. Właściwość updateUserNames określa nazwy użytkowników, których role w grupie zaktualizowano, zwracając listę nazw użytkowników w obiekcie JSON properties.
Przykład
"properties": {
"updatedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Element zostanie udostępniony grupie
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/itemShare, mają w ładunku właściwość sharedItems. Właściwość sharedItems określa itemID i typ elementu udostępnianego grupie, zwracając te informacje w obiekcie JSON properties.
Przykład
"properties": {
"sharedItems": [
{
"itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
"itemType": "Map Package"
}
]
}
Element przestanie być udostępniany konkretnej grupie
Elementy webhook, które subskrybują wyzwalacz zdarzenia /groups/<groupID>/itemUnshare, mają w ładunku właściwość unsharedItems. Właściwość unsharedItems określa itemID i typ elementu, którego udostępniania grupie zaprzestano, zwracając te informacje w obiekcie JSON properties.
Przykład
"properties": {
"unsharedItems": [
{
"itemId": "7dd95fadaec84859ab8ed1059e675e0c",
"itemType": "Image"
}
]
}
Zdarzenia użytkowników instytucji
W poniższej tabeli podano wyzwalacze zdarzeń dla użytkowników instytucji:
Wyzwalacz zdarzenia | URI |
---|---|
Wszystkie zdarzenia wyzwalacza dla wszystkich użytkowników w portalu | /users |
Użytkownik zostanie dodany do instytucji | /users/add |
Dowolny użytkownik zalogował się do portalu | /users/signin |
Dowolny użytkownik wylogował się z portalu | /users/signout |
Dowolny użytkownik zostanie usunięty | /users/delete |
Profil dowolnego użytkownika zostanie zaktualizowany Notatka:Zdarzenie aktualizacji jest wyzwalane za każdym razem, gdy jest wprowadzana zmiana w profilu użytkownika. Jednak zmiany obejmujące rolę użytkownika, typ użytkownika lub licencję nie są uwzględniane jako aktualizacja profilu użytkownika. | /users/update |
Konto dowolnego użytkownika zostanie wyłączone | /users/disable |
Konto dowolnego użytkownika zostanie włączone | /users/enable |
Nastąpi przypisanie nowej roli do dowolnego użytkownika | /users/updateUserRole |
Nastąpi przypisanie nowego typu użytkownika do dowolnego użytkownika | /users/updateUserLicenseType |
Lista kont użytkowników zostanie włączona | /users/bulkEnable |
Lista kont użytkowników zostanie wyłączona | /users/bulkDisable |
Wszystkie zdarzenia wyzwalacza powiązane z konkretnym użytkownikiem | /users/<username> |
Podany użytkownik zalogował się do portalu | /users/<username>/signIn |
Podany użytkownik wylogował się z portalu | /users/<username>/signOut |
Konkretny użytkownik zostanie usunięty | /users/<username>/delete |
Profil konkretnego użytkownika zostanie zaktualizowany Notatka:Zdarzenie aktualizacji jest wyzwalane za każdym razem, gdy jest wprowadzana zmiana w profilu użytkownika. Jednak zmiany obejmujące rolę użytkownika, typ użytkownika lub licencję nie są uwzględniane jako aktualizacja profilu użytkownika. | /users/<username>/update |
Konto konkretnego użytkownika zostanie wyłączone | /users/<username>/disable |
Konto konkretnego użytkownika zostanie włączone | /users/<username>/enable |
Do konkretnego użytkownika przypisano nową rolę | /users/<username>/updateUserRole |
Do konkretnego użytkownika przypisano nowy typ użytkownika | /users/<username>/updateUserLicenseType |
Właściwości wyzwalacza zdarzenia użytkownika
Niektóre wyzwalacze zdarzeń dla użytkowników instytucji zwracają w ładunkach dodatkowe właściwości. W poniższych sekcjach przedstawiono dodatkowe właściwości ładunku dla tych wyzwalaczy.
Do konkretnego użytkownika przypisano nową rolę
Elementy webhook, które subskrybują wyzwalacz zdarzenia /users/<username>/updateUserRole, mają w ładunku właściwość userRoleUpdatedTo. Właściwość userRoleUpdatedTo określa nową rolę przypisaną użytkownikowi, zwracając tę nową rolę w obiekcie JSON properties.
"properties": {
"userRoleUpdatedTo": ["New role"]
}
Do konkretnego użytkownika przypisano nowy typ użytkownika
Elementy webhook, które subskrybują wyzwalacz zdarzenia /users/<username>/updateUserLicenseType, mają w ładunku właściwość userLicenseTypeUpdatedTo. Właściwość userLicenseTypeUpdatedTo określa nowy typ użytkownika, który przypisano użytkownikowi, zwracając nowy typ użytkownika w obiekcie JSON properties.
"properties": {
"userLicenseTypeUpdatedTo": ["Editor"]
}
Zdarzenia ról instytucji
W poniższej tabeli podano wyzwalacze zdarzeń dla ról użytkowników instytucji:
Wyzwalacz zdarzenia | URI |
---|---|
Wszystkie zdarzenia wyzwalacza dla wszystkich ról w portalu | /roles |
Zostanie utworzona nowa rola | /roles/add |
Zostanie zaktualizowana istniejąca rola Notatka:Zdarzenie aktualizacji jest wyzwalane za każdym razem, gdy jest wprowadzana zmiana w rolach w instytucji. | /roles/update |
Zostanie usunięta istniejąca rola | /roles/delete |
Właściwości wyzwalacza zdarzenia roli
Niektóre wyzwalacze zdarzeń dla ról instytucji zwracają w ładunkach dodatkowe właściwości. W poniższej sekcji przedstawiono dodatkowe właściwości ładunku dla tych wyzwalaczy.
Zostanie utworzona nowa rola
Elementy webhook, które subskrybują wyzwalacz zdarzenia /roles/add, mają w ładunku właściwość name. Właściwość name określa nazwę utworzonej roli, zwracając tę nazwę roli w obiekcie JSON properties.
Przykład
"properties": {
"name": ["New role"]
}
Zdarzenia usług obiektowych
W poniższej tabeli podano wyzwalacze zdarzeń dla elementów webhook usług obiektowych:
Wyzwalacz zdarzenia | Wartość |
---|---|
Zostanie wyzwolone dowolne zdarzenie | * |
Jest tworzony nowy obiekt | FeaturesCreated |
Obiekt jest aktualizowany | FeaturesUpdated |
Obiekt jest usuwany | FeaturesDeleted |
Obiekt jest edytowany (np. wstawienie, aktualizacja lub usunięcie) | FeaturesEdited |
Do obiektu jest dodawany nowy załącznik | AttachmentsCreated |
Załącznik obiektu jest aktualizowany | AttachmentsUpdated |
Załącznik obiektu jest usuwany | AttachmentsDeleted |
Zostanie zmieniony schemat warstwy obiektowej | LayerSchemaChanged |
Zostanie zmieniona definicja warstwy obiektowej | LayerDefinitionChanged |
Zostanie zmieniona definicja usługi obiektowej | FeatureServiceDefinitionChanged |
Operacja post jest wykonywana na usłudze obiektowej. Notatka:Aby zaplanować element webhook przy użyciu tego wyzwalacza zdarzenia, usługa obiektowa musi mieć włączoną funkcję zarządzania wersjami. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją Tworzenie elementów webhook. | FeaturesPosted |