ペイロード—ArcGIS Enterprise on Kubernetes

Webhook がトリガーされると、ペイロードが特定のペイロード URL に配信されます。特定の Webhook タイプの各イベントは、対応するイベントに関連する情報を含む同様の JSON スキーマに従います。以下のセクションでは、ペイロードに含まれるプロパティを定義し、組織 Webhook とサービス Webhook のペイロードの例を示します。

組織 Webhook のペイロード

次の表は、組織 Webhook のペイロードに含まれるプロパティを示し、組織内のユーザー、グループ、アイテム、およびロールの変更と更新に関する情報を返します。


プロパティ	Description
webhookName	ペイロードを配信した Webhook の名前。
webhookId	ペイロードを配信した Webhook の ID。
portalURL	Webhook が登録されているポータルの 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	操作が実行されたアイテムタイプ。 item、group、または user のいずれかです。
id	操作が実行されたソースアイテムの ID。
properties	特定のイベントトリガーに関連付けられているその他のプロパティ。次のリストに、ペイロードに含まれるその他のプロパティの概要を示します。その他のプロパティが含まれるかイベントトリガーの詳細については、「イベントトリガー」を参照するか、以下のプロパティをクリックして特定のトリガーとそのプロパティの詳細をご参照ください。 sharedToGroups unsharedFromGroups removeUserNames updateUserNames invitedUserNames addedUserNames userRoleUpdatedTo reassignedTo userLicenseTypeUpdatedTo name

ペイロードの例

次の例は、特定のグループが更新されたときにトリガーされる組織 Webhook のサンプルペイロードを示しています。

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

ジオプロセシングサービス Webhook のペイロード

次の表は、ジオプロセシングサービス Webhook のペイロードに含まれるプロパティを示し、ジオプロセシングサービスに加えられた変更に関する情報を返します。


プロパティ	Description
serviceType	Webhook が構成されたサービスタイプ。フィーチャサービス Webhook の場合、このプロパティは GPServer のみを返します。
jobId	ジオプロセシングサービスジョブの ID
statusURL	ポーリングしてジョブのステータス情報が返される、ジオプロセシングサービスジョブのステータス URL。
name	Webhook 名。
taskName	ジオプロセシングツール名。
folderName	ジオプロセシングサービスが配置されているフォルダー。
serviceName	ジオプロセシングサービスの名前。
eventType	ジオプロセシングサービスジョブが完了した状態を表すプロパティ。ジオプロセシングサービス Webhook は特定のイベントトリガーに登録されていません。その代わりに、ジオプロセシングサービスのジョブが完了すると、これらの Webhook はそのペイロードを配信します。これらのペイロードは、ジョブが正常に完了したこと (esriJobSucceeded)、正常に完了しなかったこと (esriJobFailed)、またはジョブがキャンセルされたこと (esriJobCancelled) を示します。値: esriJobSucceeded \| esriJobFailed \| esriJobCancelled
when	ジョブが完了したときのタイムスタンプ (エポックからのミリ秒)。

ペイロードの例

次の例は、ジオプロセシングサービスジョブが完了した際にトリガーするジオプロセシングサービス Webhook のサンプルペイロードを示しています。

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

フィーチャサービス Webhook のペイロード

次の表は、フィーチャサービス Webhook のペイロードに含まれるプロパティを示し、フィーチャサービスに加えられた変更に関する情報を返します。


プロパティ	Description
serviceType	Webhook が構成されたサービスタイプ。フィーチャサービス Webhook の場合、このプロパティは FeatureServer のみを返します。
changesUrl	サービスの変更の抽出エンドポイントの URL。ペイロードにはイベントトリガーと発生時間のみが含まれていますが、この URL にアクセスして、イベント中に発生した特定の変更の詳細を確認できます。
id	ペイロードを配信した Webhook の ID。
folderName	フィーチャサービスが配置されているフォルダー。
serviceName	フィーチャサービスの名前。
eventType	フィーチャサービスで実行されるイベントタイプ。 Webhook を構成する際に登録できる変更タイプの値の詳細については、「イベントトリガー」トピックをご参照ください。値: * \| FeaturesCreated \| FeaturesUpdated \| FeaturesDeleted \| FeaturesEdited \| AttachmentsCreated \| AttachmentsUpdated \| AttachmentsDeleted \| LayerSchemaChanged \| LayerDefinitionChanged \| FeatureServiceDefinitionChanged
when	イベントが発生したときのタイムスタンプ (エポックからのミリ秒)。

ペイロードの例

次の例は、フィーチャサービスが更新 (FeaturesUpdated)、削除 (FeaturesDeleted)、および編集 (FeaturesEdited) された際にトリガーするフィーチャサービス Webhook のサンプルペイロードを示しています。

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

このトピックへのフィードバック

組織 Webhook のペイロード

ペイロードの例

ジオプロセシング サービス Webhook のペイロード

ペイロードの例

フィーチャ サービス Webhook のペイロード

ペイロードの例

このトピックの内容

ジオプロセシングサービス Webhook のペイロード

フィーチャサービス Webhook のペイロード