Полезные данные—ArcGIS Enterprise on Kubernetes

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

Полезные данные вебхуков организации

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


Свойство	Описание
webhookName	Имя вебхука, который доставляет полезные данные.
webhookId	ID вебхука, который доставляет полезные данные.
portalURL	URL-адрес портала, на котором зарегистрирован вебхук.
when	Время отправки полезных данных.
username	Пользователь инициирующий событие.
userId	ID пользователя, инициирующего событие.
when	Время происшествия события.
operation	Тип операции, выполненной пользователем. В приведенном ниже списке представлены свойства типа операции, содержащиеся в полезных данных, и соответствующие им операции Portal Directory API: add: Добавить элемент, Создать группу, Создать роль addUsers: Добавить пользователей в группу delete: Удалить элемент, Удалить группу, Удалить пользователя, Удалить роль disable: Отключить пользователя enable: Включить пользователя invite: Пригласить в группу move: Переместить элемент protect: Защитить группу publish: Опубликовать элемент removeUsers: Удалить пользователя из группы share: Опубликовать элемент unprotect: Снять защиту группы unshare: Отменить общий доступ update: Обновить элемент, Обновить группу, Обновить пользователя, Обновить роль
source	Тип элемента, для которого была выполнена операция. Это может быть items, group или user.
id	ID источника элемента, для которого была выполнена операция.
properties	Дополнительные свойства, связанные с определенными триггерами событий. Следующий список содержит описание дополнительных свойств, входящих в полезные данные. Дополнительные сведения о том, какие триггеры событий включают дополнительные свойства, см. в разделе Триггеры событий или щелкните свойства ниже для получения информации о конкретном триггере и его свойствах. sharedToGroups unsharedFromGroups removeUserNames updateUserNames invitedUserNames addedUserNames userRoleUpdatedTo reassignedTo userLicenseTypeUpdatedTo name

Пример полезных данных

Ниже показан пример полезных данных для вебхука организации, который запускается при обновлении определенной группы:

{
  "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": {}
    }
  ]
}

Полезные данные вебхука сервиса геообработки

Следующая таблица содержит список свойств, включенных в полезные нагрузки для вебхуков сервисов геообработки, которые возвращают информацию об изменениях, внесенных в эти сервисы геообработки.


Свойство	Описание
serviceType	Тип сервиса, для которого был настроен данный вебхук. В случае вебхуков сервисов объектов это свойство будет возвращать только GPServer.
jobId	ID задания сервиса геообработки.
statusURL	URL-адрес статуса задания сервиса геообработки, который может быть использован для получения информации о статусе задания.
name	Имя вебхука.
taskName	Имя инструмента геообработки.
folderName	Папка, в которой располагается сервис геообработки.
serviceName	Имя сервиса геообработки.
eventType	Свойство, показывающее, как было завершено задание сервиса геообработки. Вебхуки сервисов геообработки не поддерживают подписки на определенные триггеры событий. Эти вебхуки, скорее, доставляют свои полезные данные уже после завершения задания сервисом геообработки. Эти полезные данные показывают, было ли задание выполнено успешно (esriJobSucceeded), неудачно (esriJobFailed) или оно было отменено (esriJobCancelled). Значения: esriJobSucceeded \| esriJobFailed \| esriJobCancelled
when	Временная метка (в миллисекундах с начала периода отсчета) момента завершения задания.

Пример полезных данных

Ниже показан пример полезных данных для вебхука сервиса геообработки, который запускается при завершении задания сервиса геообработки.

{
  "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
    }
  ]
}

Полезные данные вебхуков сервисов объектов

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


Свойство	Описание
serviceType	Тип сервиса, для которого был настроен данный вебхук. В случае вебхуков сервисов объектов это свойство будет возвращать только FeatureServer.
changesUrl	URL-адрес конечной точки Извлечь изменения для данного сервиса. Несмотря на то, что в полезные данные включается только триггер события и время его возникновения, вы можете перейти по этому URL-адресу и получить дополнительные сведения о конкретных изменениях, произошедших во время события.
id	ID вебхука, который доставляет полезные данные.
folderName	Папка, в которой находится сервис объектов.
serviceName	Имя сервиса объектов.
eventType	Тип события, которое выполняется в сервисе объектов. Для получения дополнительной информации о значениях типа изменений, на которые можно подписаться при настройке вебхуков, см. раздел Триггеры событий. Значения: * \| FeaturesCreated \| FeaturesUpdated \| FeaturesDeleted \| FeaturesEdited \| AttachmentsCreated \| AttachmentsUpdated \| AttachmentsDeleted \| LayerSchemaChanged \| LayerDefinitionChanged \| FeatureServiceDefinitionChanged
when	Временная метка (в миллисекундах с начала периода отсчета) момента совершения события.

Пример полезных данных

В следующем примере показан пример полезных данных для вебхука сервиса объектов, который запускается при обновлении (FeaturesUpdated), удалении (FeaturesDeleted) и редактировании (FeaturesEdited) сервиса объектов:

{
  "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
    }
  ]
}

Отзыв по этому разделу?