イベント トリガー

Webhook を作成する際、API 操作に関連付けられた特定のイベント トリガーに登録し、Webhook を呼び出してペイロードを通じてイベントの情報を配信できます。 以下のセクションでは、組織およびフィーチャ サービス Webhook で使用できるイベント トリガーと、関連する URI および変更タイプの値について説明します。

注意:

組織 Webhook およびフィーチャ サービス Webhook とは異なり、ジオプロセシング サービス Webhook には、ユーザー定義のイベント トリガーがありません。 ジオプロセシング サービス Webhook はジオプロセシング ジョブが完了するとペイロードを配信します。 ジオプロセシング サービスで配信されるペイロードの詳細については、「ペイロード」トピックをご参照ください。

組織アイテムのイベント

次の表に、Web マップ、Web アプリ、レイヤー、パッケージ、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 オペレーションをトリガーする固有の操作があります。 たとえば、アイテムが Web マップの場合、タグの更新、ポップアップの構成、ベースマップの変更などはすべて Webhook をトリガーする更新イベントになります。	/items/<itemID>/update
特定のアイテムの所有権が変更されたか、アイテムが移動された	/items/<itemID>/move
特定のアイテムが公開された	/items/<itemID>/publish
特定のアイテムが共有された	/items/<itemID>/share
特定のアイテムの共有が解除された	/items/<itemID>/unshare
特定のアイテムの所有権が再割り当てされた	/items/<itemID>/reassign

アイテムのイベント トリガー プロパティ

一部の組織アイテムのイベント トリガーのペイロードには、追加プロパティが返されます。 以下のセクションでは、これらのトリガーの追加ペイロード プロパティの概要を説明します。

特定のアイテムが共有された

/items/<itemID>/share イベント トリガーに登録している Webhook のペイロードには、sharedToGroups プロパティが追加されます。 sharedToGroups プロパティでは、アイテムが共有された方法を指定します。 アイテムがグループと共有された場合、properties JSON オブジェクトには、アイテムが共有された各グループの ID が含まれます。 アイテムが組織全体と共有された場合、オブジェクトには Organization が含まれます。 アイテムがパブリックに共有された場合、オブジェクトには Everyone が含まれます。 以下の例では、特定グループへのアイテムの共有、およびパブリックと特定グループの両方へのアイテムの共有を示します。

例

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

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

任意のアイテムの所有権が再割り当てされた

/items/reassign イベント トリガーに登録している Webhook のペイロードには、reassignedTo プロパティが追加されます。 reassignedTo プロパティでは、アイテムまたはグループが再割り当てされる新しいユーザーを指定し、properties JSON オブジェクトに新しい所有者のユーザー名を返します。

例

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

特定のアイテムの共有が解除された

/items/<itemID>/unshare イベント トリガーに登録している Webhook のペイロードには、unsharedFromGroups プロパティが追加されます。 unsharedFromGroups プロパティでは、アイテムの共有が解除された方法を指定します。 アイテムのグループとの共有が解除された場合、properties JSON オブジェクトには、アイテムの共有が解除された各グループの ID が含まれます。 アイテムの組織全体との共有が解除された場合、オブジェクトには Organization が含まれます。 アイテムのパブリックとの共有が解除された場合、オブジェクトには Everyone が含まれます。 以下のプロパティの例では、アイテムのパブリックとの共有の解除、および特定のグループとの共有の解除を示します。

例

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

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

特定のアイテムの所有権が再割り当てされた

/items/<itemID>/reassign イベント トリガーに登録している Webhook のペイロードには、reassignedTo プロパティが追加されます。 reassignedTo プロパティでは、アイテムまたはグループが割り当てられる新しいユーザーを指定し、properties JSON オブジェクトに新しい所有者のユーザー名を返します。

例

"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/itemShare
任意のグループからアイテムの共有が解除された	/groups/itemUnshare
特定のグループに対するすべてのトリガー イベント	/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 イベント トリガーに登録している Webhook のペイロードには、invitedUserNames プロパティが追加されます。 invitedUserNames プロパティでは、グループに招待されたユーザーのユーザー名を指定し、properties JSON オブジェクトにユーザー名のリストを返します。

例

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

ユーザーが特定のグループに追加された

/groups/<groupID>/addUsers イベント トリガーに登録している Webhook のペイロードには、addedUserNames プロパティが追加されます。 addedUserNames プロパティでは、グループに追加されたユーザーのユーザー名を指定し、properties JSON オブジェクトにユーザー名のリストを返します。

例

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

ユーザーが特定のグループから削除された

/groups/<groupID>/removeUsers に登録している Webhook のペイロードには、removeUserNames プロパティが追加されます。 removeUserNames プロパティでは、グループから削除されたユーザーのユーザー名を指定し、properties JSON オブジェクトにユーザー名のリストを返します。

例

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

ユーザーのロールが特定のグループで更新された

/groups/<groupID>/updateUsers に登録している Webhook のペイロードには、updateUserNames プロパティが追加されます。 updateUserNames プロパティでは、グループ ロールが更新されたユーザーのユーザー名を指定し、properties JSON オブジェクトにユーザー名のリストを返します。

例

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

アイテムが、グループに共有されます。

/groups/<groupID>/itemShare に登録している Webhook のペイロードには、sharedItems プロパティが追加されます。 sharedItems プロパティでは、グループに共有されたアイテムの itemID およびアイテム タイプを指定し、properties JSON オブジェクトにこの情報を返します。

例

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

アイテムは特定のグループから共有されていません。

/groups/<groupID>/itemUnshare に登録している Webhook のペイロードには、unsharedItems プロパティが追加されます。 unsharedItems プロパティでは、グループとの共有が解除されたアイテムの itemID およびアイテム タイプを指定し、properties JSON オブジェクトにこの情報を返します。

例

"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/bulkEnable
ユーザー アカウントのリストが無効化された	/users/bulkDisable
特定のユーザーに関連付けられているすべてのトリガー イベント	/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 に登録している Webhook のペイロードには、userRoleUpdatedTo プロパティが追加されます。 userRoleUpdatedTo プロパティでは、ユーザーが割り当てられる新しいロールを指定し、properties JSON オブジェクトに新しいロールを返します。

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

特定のユーザーに新しいユーザー タイプが割り当てられた

/users/<username>/updateUserLicenseType に登録している Webhook のペイロードには、userLicenseTypeUpdatedTo プロパティが追加されます。 userLicenseTypeUpdatedTo プロパティでは、ユーザーが割り当てられる新しいユーザー タイプを指定し、properties JSON オブジェクトに新しいユーザー タイプを返します。

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

組織ロールのイベント

次の表に、組織のユーザー ロールのイベント トリガーを示します。

イベント トリガー	URI
ポータル内の全ロールに対するすべてのトリガー イベント	/roles
新しいロールが作成された	/roles/add
既存のロールが更新された 注意: 更新イベントは、組織のロールが変更されるたびにトリガーされます。	/roles/update
既存のロールが削除された	/roles/delete

ロールのイベント トリガー プロパティ

一部の組織ロールのイベント トリガーのペイロードには、追加プロパティが返されます。 以下のセクションでは、これらのトリガーの追加ペイロード プロパティの概要を説明します。

新しいロールが作成された

/roles/add イベント トリガーに登録している Webhook のペイロードには、name プロパティが追加されます。 name プロパティでは、作成されたロールの名前を指定し、properties JSON オブジェクトにロールの名前を返します。

例

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

フィーチャ サービスのイベント

次の表に、フィーチャ サービス Webhook のイベント トリガーを示します。

イベント トリガー	値
任意のイベントがトリガーされた	*
新しいフィーチャが作成された	FeaturesCreated
フィーチャが更新された	FeaturesUpdated
フィーチャが削除された	FeaturesDeleted
フィーチャが編集された (例: 挿入、更新、削除)	FeaturesEdited
フィーチャに新しい添付ファイルが追加された	AttachmentsCreated
フィーチャの添付ファイルが更新された	AttachmentsUpdated
フィーチャの添付ファイルが削除された	AttachmentsDeleted
フィーチャ レイヤーのスキーマが変更された	LayerSchemaChanged
フィーチャ レイヤーの定義が変更された	LayerDefinitionChanged
フィーチャ サービスの定義が変更された	FeatureServiceDefinitionChanged