サブスクリプションの更新Update a subscription

SharePoint リスト上で webhook サブスクリプションを更新します。Updates a webhook subscription on a SharePoint list.

アクセス許可Permissions

アプリケーションには、少なくともサブスクリプションが更新される SharePoint リストへの編集許可が必要です。The application must have at least edit permissions to the SharePoint list where the subscription will be updated.

アプリケーションが、Microsoft Azure Active Directory (Azure AD) アプリケーションである場合If your application is a Microsoft Azure Active Directory (AD) application:

Azure AD のアプリケーションに次の表で指定されるアクセス許可を与える必要があります。サブスクリプションは、それを作成した Azure AD のアプリケーションでのみ更新できます。You must grant the Azure AD application the permissions specified in the following table. A subscription can only be updated by the Azure AD application that created it.

アプリケーションApplication アクセス許可Permission
Office 365 SharePoint OnlineOffice 365 SharePoint Online すべてのサイト コレクション内のアイテムおよびリストを読み取り、書き込みます。Read and write items and lists in all site collections.

アプリケーションが SharePoint アドインである場合If your application is a SharePoint add-in:

次のアクセス許可もしくはそれ以上の許可を SharePoint アドインに与える必要があります。You must grant the SharePoint add-in the following permission(s) or higher. サブスクリプションは、それを作成した SharePoint アドインでのみ更新できます。You must grant the SharePoint add-in the following permission(s) or higher. A subscription can only be updated by the SharePoint add-in that created it.

スコープScope アクセス権限Permission Rights
リストList 管理Manage

HTTP 要求HTTP request

PATCH _api/web/lists('list-id')/subscriptions('id')

Example

PATCH _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D77031A-2345-5GRT-BV3D-55234B56FR43')
Content-Type: application/json

{
  "notificationUrl": "https://contoso.azurewebsites.net/api/v2/webhook-receiver",
  "expirationDateTime": "2016-01-03T11:23:00.000Z"
}

要求本文Request body

要求の本文には次のプロパティが含まれます。Include the following properties in the request body.

名前Name Type 説明Description
notificationUrlnotificationUrl 文字列string 通知の送信先のサービス URL。The service URL to send notifications to.
expirationDateTimeexpirationDateTime 日付date 通知の有効期限が切れ、削除される日。The date the notification will expire and be deleted.
client-clientStateclient-clientState 文字列string 省略可能。Optional. すべての通知でクライアントに送り返される不明瞭な文字列。Optional. Opaque string passed back to the client on all notifications. You can use this for validating notifications, or tagging different subscriptions.
これは通知の検証や、他のサブスクリプションのタグ付けで使用できます。Optional. Opaque string passed back to the client on all notifications. You can use this for validating notifications, or tagging different subscriptions.

応答Response

サブスクリプションが見つかり、正常に更新されると、204 No Content 応答が返されます。If the subscription is found and successfully updated, then a 204 No Content response is returned:

Example

HTTP/1.1 204 No Content

関連項目See also