Partager via

Obtention d’abonnements

  • Article

Obtient un ou plusieurs abonnements de webhook sur une liste SharePoint.

Autorisations

Obtenir un seul abonnement

L’application doit au moins disposer d’autorisations de modification sur la liste SharePoint où l’abonnement sera récupéré.

Si votre application est une application Microsoft Azure Active Directory (Azure AD) :

You must grant the Azure AD application the permissions specified in the following table. A subscription can only be retrieved by the Azure AD application that created it.

Application Autorisation
Office 365 SharePoint Online Lire et écrire des éléments et des listes dans toutes les collections de sites.

Si votre application est un complément SharePoint :

Vous devez accorder au complément SharePoint les autorisations suivantes ou des autorisations supérieures : Un abonnement peut uniquement être récupéré par le complément SharePoint qui l’a créé.

Domaine d’application Droits d’autorisation
Répertorier Gérer

Obtention de tous les abonnements

L’application doit disposer d’autorisations de gestion de liste pour la liste SharePoint dans laquelle l’abonnement sera récupéré.

Si votre application est une application Azure AD

Vous devez accorder à l’application Azure AD les autorisations définies dans le tableau suivant.

Application Autorisation
Office 365 SharePoint Online Contrôle total de toutes les collections de sites.

Si votre application est un complément SharePoint :

Vous devez accorder au complément SharePoint les autorisations suivantes ou des autorisations supérieures :

Domaine d’application Droits d’autorisation
Répertorier Contrôle total

Requête HTTP

Obtenir un seul abonnement

Webhook de liste

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

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Renvoie l’abonnement de manière visible par l’application appelante.

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

Obtention de tous les abonnements

Webhook de liste

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

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Renvoie une collection de tous les abonnements sur une ressource 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"
    }
  ]
}

Voir aussi