获取订阅

在 SharePoint 列表中获取一个或多个 webhook 订阅。

Permissions

获取单个订阅

应用程序必须至少具有对 SharePoint 列表的编辑权限,将在该列表中检索订阅。

如果你的应用程序是 Microsoft Azure Active Directory (Azure AD) 应用程序

必须授予 Azure AD 应用程序在下表中指定的权限。只能由创建订阅的 Azure AD 应用程序来检索订阅。

应用程序 权限
Office 365 SharePoint Online 在所有网站集中读取和写入项及列表。

如果你的应用程序是 SharePoint 加载项

必须向 SharePoint 加载项授予以下权限或更高权限。 只能由创建订阅的 SharePoint 加载项来检索订阅。

范围 权限
列表 管理

获取所有订阅

应用程序必须具有对 SharePoint 列表的管理列表权限,将在该列表中检索订阅。

如果你的应用程序是 Azure AD 应用程序

必须向 Azure AD 应用授予下表中指定的权限。

应用程序 权限
Office 365 SharePoint Online 具有对所有网站集的完全控制权限。

如果你的应用程序是 SharePoint 加载项

必须向 SharePoint 加载项授予以下权限或更高权限。

范围 权限
列表 完全控制

HTTP 请求

获取单个订阅

列表 webhook

GET _api/web/lists('list-id')/subscriptions('id')
示例
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D77031A-2345-5GRT-BV3D-55234B56FR43')

请求正文

请勿提供此方法的请求正文。

响应

这将返回可由调用应用程序查看的订阅。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "odata.metadata": "https://contoso.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions/@Element",
  "odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
  "odata.id": "https://contoso.sharepoint.com/_api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
  "odata.editLink": "web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
  "expirationDateTime": "2016-04-30T16:17:57Z",
  "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
  "notificationUrl": "https://contoso.azurewebistes.net/api/webhook/handlerequest",
  "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
}

获取所有订阅

列表 webhook

GET _api/web/lists('list-id')/subscriptions
示例
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions

请求正文

请勿提供此方法的请求正文。

响应

这将返回 SharePoint 资源上所有订阅的集合。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "odata.metadata": "https://a830edad9050849295j16032914.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions",
  "value": [
    {
      "odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
      "odata.id": "https://contoso.sharepoint.com/_api/Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
      "odata.editLink": "Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
      "clientState": "{A0A354EC-97D4-4D83-9DDB-144077ADB449}",
      "expirationDateTime": "2016-04-30T16:17:57Z",
      "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
      "notificationUrl": "https://contoso.azurewebsites.net/api/webhook/handlerequest",
      "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
    }
  ]
}

另请参阅