Obtener suscripciones

  • Artículo

Obtiene una o varias suscripciones de webhook en una lista de SharePoint.

Permisos

Obtener una única suscripción

La aplicación debe tener al menos permisos de edición en la lista de SharePoint donde se recuperará la suscripción.

Si la aplicación es una aplicación de Microsoft Azure Active Directory (Azure AD)

Debe conceder a la aplicación de Azure AD los permisos que se especifican en la siguiente tabla. La aplicación de Azure AD que ha creado la suscripción es la única que la puede recuperar.

Aplicación Permiso
Office 365 SharePoint Online Leer y escribir elementos y listas en todas las colecciones de sitios.

Si la aplicación es un complemento de SharePoint

Debe conceder al complemento de SharePoint los siguientes permisos u otros superiores. El complemento de SharePoint que ha creado la suscripción es el único que la puede recuperar.

Ámbito Derechos de permiso
Lista Administrar

Obtener todas las suscripciones

La aplicación debe tener permisos de administración de lista en la lista de SharePoint donde se recuperará la suscripción.

Si la aplicación es una aplicación de Azure AD

Debe conceder a la aplicación de Azure AD los permisos que se especifican en la siguiente tabla.

Aplicación Permiso
Office 365 SharePoint Online Tomar el control total de todas las colecciones de sitios.

Si la aplicación es un complemento de SharePoint

Debe conceder al complemento de SharePoint los siguientes permisos u otros superiores.

Ámbito Derechos de permiso
Lista Control total

Solicitud HTTP

Obtener una única suscripción

Webhook de lista

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

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Esto hace que la aplicación que llama pueda ver la suscripción.

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

Obtener todas las suscripciones

Webhook de lista

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

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Devuelve una colección de todas las suscripciones en un recurso de 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"
    }
  ]
}

Consulte también