イベントトリガー—Portal for ArcGIS | ArcGIS Enterprise のドキュメント

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/<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/<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/updated
既存のロールが削除された	/roles/delete

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

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

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

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

例


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

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

注意:

このリリースでは、サービス Webhook はベータ機能です。ベータ版では、これらの機能は完全ではない可能性があるため、場合によってはパフォーマンスまたは品質に関する既知の問題があり、Esri テクニカルサポートによるサポートはありません。サービス Webhook のベータ版 API ドキュメントについては、サービス Webhook 管理者 API ガイド (PDF) をご参照ください。 ArcGIS Enterprise のベータ機能の詳細については、「ベータ機能」をご参照ください。

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


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

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

注意: