Триггеры событий

При создании вебхуков вы можете подписаться на определенные триггеры событий, привязанные к операциям API, которые будут вызывать ваш вебхук и доставлять информацию о событии посредством полезных данных. В следующих разделах представлены доступные триггеры событий и соответствующие URI-адреса или значения типа изменения для вебхуков сервисов объектов или организаций.

Примечание:

В отличие от вебхуков сервисов организаций и объектов, вебхуки сервисов геообработки не имеют триггеров событий, которые задаются пользователем. Вебхуки сервисов геообработки доставляют полезные данные по завершении задания геообработки. Более подробную информацию о полезных данных, передаваемых для сервисов геообработки, см. в разделе Полезные данные.

События элементов организаций

В следующей таблице представлены триггеры событий для элементов организации, к которым относятся веб-карты, веб-приложения, слои, пакеты и PDF-файлы:

Триггер событий	URI
Все инициирующие события для всех элементов	/items
Элемент добавляется на портал	/items/add
Любой элемент удаляется	/items/delete
Любой элемент обновляется	/items/update
Какой-то элемент перемещен или его собственник изменен	/items/move
Любой элемент публикуется	/items/publish
Любой элемент является общим	/items/share
Любой элемент не является общим	/items/unshare
Переназначается право собственности на любой элемент	/items/reassign
Все инициирующие события для определенного элемента	/items/<itemID>
Определенный элемент удаляется	/items/<itemID>/delete
Свойства определенного элемента обновляются Примечание: Свойства элементов, которые могут быть обновлены, различаются в зависимости от типа элементов, и существуют уникальные действия, запускающие операцию Update. Например, если элемент представляет собой веб-карту, то обновление тега, настройка всплывающего окна или изменение базовой карты - это все события обновления, которые приводят в действие вебхук.	/items/<itemID>/update
Право собственности на определенный элемент изменено или он перемещен	/items/<itemID>/move
Определенный элемент публикуется	/items/<itemID>/publish
Определенный элемент является общим	/items/<itemID>/share
Определенный элемент не является общим	/items/<itemID>/unshare
Переназначается право собственности на определенный элемент	/items/<itemID>/reassign

Свойства триггеров событий элементов

Некоторые триггеры событий для элементов организаций возвращают дополнительные свойства в своих полезных данных. В приведенных ниже разделах описываются дополнительные свойства полезных данных для этих триггеров.

Определенный элемент является общим

В полезные данные вебхуков с подпиской на триггер событий /items/<itemID>/share включено свойство sharedToGroups. Свойство sharedToGroups определяет собой, каким способом была выполнена публикация элемента. Если элемент был опубликован в группе, то объект JSON properties будет содержать ID для каждой группы, в которой этот элемент был опубликован. Если элемент был опубликован для целой организации, то такой объект будет содержать Organization. Если элемент был опубликован для всех, то объект будет содержать Everyone. В приведенном ниже примере показана публикация элемента для определенных групп, а также публикация для всех и для определенных групп.

Примеры

//groupIDs
"properties": {
  "sharedToGroups": [
    "ecd6646698b24180904e4888d5eaede3",
    "2dff15c514ad4f04b291e304e24a524b"
  ]
}

//Everyone and groupIDs
"properties": {
  "sharedToGroups": [
    "Everyone",
    "4adc30bb03054812a846fa592de105de",
    "a4e6e37e2f7d4bb5b64d587c91d39a2c"
  ]
}

Переназначается право собственности на любой элемент

В полезные данные вебхуков с подпиской на триггер событий /items/reassign включено свойство reassignedTo. Свойство reassignedTo определяет собой нового пользователя, которому переназначается элемент или группа, и возвращает имя пользователя нового владельца в объекте JSON properties.

Пример

"properties": {
  "reassignedTo": ["newOwner"]
}

Определенный элемент не является общим

В полезные данные вебхуков с подпиской на триггер событий /items/<itemID>/unshare включено свойство unsharedFromGroups. Свойство unsharedFromGroups определяет собой, каким способом был отменен общий доступ к элементу. Если публикация элемента была отменена из группы, то объект JSON properties будет содержать ID каждой группы, из которой была отменена публикация этого элемента. Если публикация элемента была отменена из всей организации, то объект будет содержать Organization. Если была отменена публикация элемента для всех, то объект будет содержать Everyone. Приведенные ниже примеры свойств демонстрируют отмену общего доступа к элементу для всех, а также отмену общего доступа к элементу из определенной группы.

Примеры

//Everyone
"properties": {
  "unsharedFromGroups": ["Everyone"]
}

//groupID
"properties": {
  "unsharedFromGroups": [
    "4adc30bb03054812a846fa592de105de"
  ]
}

Переназначается право собственности на определенный элемент

В полезные данные вебхуков с подпиской на триггер событий /items/<itemID>/reassign включено свойство reassignedTo. Свойство reassignedTo определяет собой нового пользователя, которому присваивается элемент или группа, и возвращает имя пользователя нового владельца в объекте JSON properties.

Пример

"properties": {
  "reassignedTo": ["newOwner"]
}

События групп организации

В следующей таблице приведены триггеры событий для групп организации:

Триггер событий	URI
Все инициирующие события для всех групп	/groups
Группа добавляется	/groups/add
Любая группа обновляется	/groups/update
Любая группа удаляется	/groups/delete
Защита от удаления включена для любой группы	/groups/protect
Защита от удаления отключена для любой группы	/groups/unprotect
Пользователь приглашен в любую группу	/groups/invite
Пользователь добавляется в любую группу	/groups/addUsers
Пользователь удален из любой группы	/groups/removeUsers
Роль пользователя обновляется в любой группе	/groups/updateUsers
Право собственности для любой группы переназначается	/groups/reassign
Все инициирующие события для определенной группы	/groups/<groupID>
Определенная группа обновляется Примечание: Любые общие изменения параметров группы представляют собой обновление. Например, изменение доступа группы вызовет событие обновления.	/groups/<groupID>/update
Определенная группа удаляется	/groups/<groupID>/delete
Защита от удаления включена для определенной группы	/groups/<groupID>/protect
Защита от удаления отключена для определенной группы	/groups/<groupID>/unprotect
Пользователь приглашен в определенную группу	/groups/<groupID>/invite
Пользователь добавляется в определенную группу	/groups/<groupID>/addUsers
Пользователь удаляется из определенной группы	/groups/<groupID>/removeUsers
Роль пользователя обновляется в определенной группе	/groups/<groupID>/updateUsers
Право собственности на определенную группу переназначено	/groups/<groupID>/reassign
Элемент является общим для группы	/groups/<groupID>/itemShare
Публикация элемента для конкретной группы отменена	/groups/<groupID>/itemUnshare

Свойства триггеров событий групп

Некоторые триггеры событий для групп организаций возвращают в полезных данных дополнительные свойства. В приведенных ниже разделах описываются дополнительные свойства полезных данных для этих триггеров.

Пользователь приглашен в определенную группу

В полезные данные вебхуков с подпиской на триггер событий /groups/<groupID>/invite включено свойство invitedUserNames. Свойство invitedUserNames определяет собой имена пользователей людей, приглашенных в группу, и возвращает список имен пользователей в объекте JSON properties.

Пример

"properties": {
  "invitedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Пользователь добавляется в определенную группу

В полезные данные вебхуков с подпиской на триггер событий /groups/<groupID>/addUsers включено свойство addedUserNames. Свойство addedUserNames определяет собой имена пользователей людей, добавленных в группу, и возвращает список имен пользователей в объекте properties JSON.

Пример

"properties": {
  "addedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Пользователь удаляется из определенной группы

В полезные данные вебхуков с подпиской на /groups/<groupID>/removeUsers включено свойство removeUserNames. Свойство removeUserNames определяет собой имена пользователей людей, удаленных из группы, и возвращает список имен пользователей в объекте JSON properties.

Пример

"properties": {
  "removedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Роль пользователя обновляется в определенной группе

В полезные данные вебхуков с подпиской на /groups/<groupID>/updateUsers включено свойство updateUserNames. Свойство updateUserNames определяет собой имена пользователей людей, чьи роли в группе были обновлены, и возвращает список имен пользователей в объекте JSON properties.

Пример

"properties": {
  "updatedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Элемент является общим для группы

В полезные данные вебхуков с подпиской на /groups/<groupID>/itemShare включено свойство sharedItems. Свойство sharedItems определяет собой itemID и тип элемента, опубликованного для группы, возвращая эту информацию в объекте JSON properties.

Пример

"properties": {
  "sharedItems": [
    {
      "itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
      "itemType": "Map Package"
    }
  ]
}

Публикация элемента для конкретной группы отменена

В полезные данные вебхуков с подпиской на /groups/<groupID>/itemUnshare включено свойство unsharedItems. Свойство unsharedItems определяет собой itemID и тип элемента, публикация которого для группы была отменена, и возвращает эту информацию в объекте JSON properties.

Пример

"properties": {
  "unsharedItems": [
    {
      "itemId": "7dd95fadaec84859ab8ed1059e675e0c",
      "itemType": "Image"
    }
  ]
}

События пользователей организации

В следующей таблице перечислены триггеры событий для пользователей организации:

Триггер событий	URI
Все инициирующие события для всех пользователей в портале	/users
Пользователь добавляется в организацию	/users/add
Любой пользователь зашел на портал	/users/signin
Любой пользователь вышел из портала	/users/signout
Любой пользователь удаляется	/users/delete
Профиль любого пользователя обновляется Примечание: Событие обновления инициируется при каждом изменении профиля пользователя. Однако изменения, внесенные в роль пользователя, тип пользователя или лицензию, не считаются обновлением профиля пользователя.	/users/update
Учетная запись любого пользователя отключается	/users/disable
Учетная запись любого пользователя включается	/users/enable
Любому пользователю назначается новая роль	/users/updateUserRole
Любому пользователю назначается новый тип пользователя	/users/updateUserLicenseType
Все инициирующие события для определенного пользователя	/users/<username>
Указанный пользователь вошел на портал	/users/<username>/signIn
Указанный пользователь вышел с портала	/users/<username>/signOut
Указанный пользователь удаляется	/users/<username>/delete
Профиль указанного пользователя обновляется Примечание: Событие обновления инициируется при каждом изменении профиля пользователя. Однако изменения, внесенные в роль пользователя, тип пользователя или лицензию, не считаются обновлением профиля пользователя.	/users/<username>/update
Учетная запись указанного пользователя отключается	/users/<username>/disable
Учетная запись указанного пользователя включается	/users/<username>/enable
Определенному пользователю назначается новая роль	/users/<username>/updateUserRole
Определенному пользователю назначается новый тип пользователя	/users/<username>/updateUserLicenseType

Свойства триггеров событий пользователей

Некоторые триггеры событий для пользователей организаций возвращают в полезных данных дополнительные свойства. В приведенных ниже разделах описываются дополнительные свойства полезных данных для этих триггеров.

Определенному пользователю назначается новая роль

В полезные данные вебхуков с подпиской на /users/<username>/updateUserRole включено свойство userRoleUpdatedTo. Свойство userRoleUpdatedTo определяет собой новую роль, назначенную пользователю, и возвращает эту новую роль в объекте JSON properties.

"properties": {
  "userRoleUpdatedTo": ["New role"]
}

Определенному пользователю назначается новый тип пользователя

В полезные данные вебхуков с подпиской на /users/<username>/updateUserLicenseType включено свойство userLicenseTypeUpdatedTo. Свойство userLicenseTypeUpdatedTo определяет собой новый тип пользователя, который присваивается пользователю, и возвращает этот новый тип пользователя в объекте JSON properties.

"properties": {
  "userLicenseTypeUpdatedTo": ["Editor"]
}

События ролей организации

В следующей таблице перечислены триггеры событий для ролей пользователей организации:

Триггер событий	URI
Все события триггера для всех ролей в портале	/roles
Новая роль создана	/roles/add
Существующая роль обновляется Примечание: Событие обновления запускается каждый раз, когда вносятся изменения в роли вашей организации.	/roles/updated
Существующая роль удаляется	/roles/delete

Свойства триггеров событий для ролей

Некоторые триггеры событий для ролей организации возвращают в полезных данных дополнительные свойства. В следующем разделе приводится описание дополнительных свойств полезных данных для этих триггеров.

Новая роль создана

В полезные данные вебхуков с подпиской на триггер событий /roles/add включено свойство name. Свойство name определяет собой имя созданной роли и возвращает имя этой роли в объекте JSON properties.

Пример

"properties": {
  "name": ["New role"]
}

События сервисов объектов

Примечание:

В этой версии вебхуки сервисов являются бета-функцией. Во время бета-тестирования эти функции могут быть не полными, иметь известные проблемы с производительностью или качеством и не будут поддерживаться технической поддержкой Esri. Документация бета-API для вебхуков сервиса доступна в Руководство по API администратора вебхуков сервиса PDF. Дополнительную информацию о функциях ArcGIS Enterprise в стадии бета-тестирования см. в разделе Бета-функции.

Следующая таблица содержит перечень триггеров событий для вебхуков сервисов объектов:

Триггер событий	Значение
При срабатывании любого события	*
Создается новый сервис объектов	FeaturesCreated
Обновляется сервис объектов	FeaturesUpdated
Удаляется сервис объектов	FeaturesDeleted
Редактируется сервис объектов	FeaturesEdited
В сервис объектов добавляется новое вложение	AttachmentsCreated
Обновляется вложение к сервису объектов	AttachmentsUpdated
Удаляется вложение к сервису объектов	AttachmentsDeleted
Изменяется схема векторного слоя	LayerSchemaChanged
Изменяется определение векторного слоя	LayerDefinitionChanged
Изменяется определение сервиса объектов	FeatureServiceDefinitionChanged