Erstellen eines neuen AbonnementsCreate a new subscription

Erstellt ein neues Webhook-Abonnement in einer SharePoint-Liste.Creates a new webhook subscription on a SharePoint list.

BerechtigungenPermissions

Die Anwendung muss mindestens Bearbeitenberechtigungen für die SharePoint-Liste haben, in der das Abonnement erstellt wird.The application must have at least edit permissions to the SharePoint list where the subscription will be created.

Wenn es sich bei Ihrer Anwendung um eine Microsoft Azure Active Directory (Azure AD)-Anwendung handeltIf your application is a Microsoft Azure Active Directory (Azure AD) application

Sie müssen der Azure AD-App die in der folgenden Tabelle angegebenen Berechtigungen erteilen:You must grant the Azure AD app the permissions specified in the following table:

AnwendungApplication BerechtigungPermission
Office 365 SharePoint OnlineOffice 365 SharePoint Online Lese-/Schreibzugriff auf Elemente und Listen in allen Websitesammlungen.Read and write items and lists in all site collections.

Wenn es sich bei Ihrer Anwendung um ein SharePoint-Add-In handeltIf your application is a SharePoint Add-in

Sie müssen dem SharePoint-Add-In mindestens die folgenden Berechtigungen erteilen:You must grant the SharePoint Add-in the following permission(s) or higher:

UmfangScope BerechtigungenPermission rights
AuflistenList VerwaltenManage

HTTP-AnforderungHTTP request

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

AnforderungstextRequest body

Schließen Sie die folgenden Eigenschaften in die Anforderung ein.Include the following properties in the request body.

NameName TypType BeschreibungDescription
resourceresource stringstring Die URL der Liste, aus der Benachrichtigungen empfangen werden.The URL of the list to receive notifications from.
notificationUrlnotificationUrl stringstring Die Dienst-URL, an den Benachrichtigungen gesendet werden.The service URL to send notifications to.
expirationDateTimeexpirationDateTime datedate Das Datum, an dem die Benachrichtigung abläuft und gelöscht wird.The date the notification will expire and be deleted.
clientStateclientState stringstring Optional.Optional. Verschlüsselte Zeichenfolge, die bei allen Benachrichtigungen zurück an den Client übergeben wird.Opaque string passed back to the client on all notifications.
Dies können Sie zum Überprüfen von Benachrichtigungen oder zum Kategorisieren unterschiedlicher Abonnements verwenden.You can use this for validating notifications or tagging different subscriptions.

BeispielExample

POST /_api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions
Accept: application/json
Content-Type: application/json

{
  "resource": "https://contoso.sharepoint.com/_api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')",
  "notificationUrl": "https://91e383a5.ngrok.io/api/webhook/handlerequest",
  "expirationDateTime": "2016-04-27T16:17:57+00:00"
}

AntwortResponse

Wenn das Abonnement hinzugefügt wird, wird eine 201 Created-Antwort zurückgegeben, die das neu erstellte Abonnementobjekt enthält.If the subscription is added, a 201 Created response is returned that includes the newly created subscription object.

BeispielExample

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
    "expirationDateTime": "2016-04-27T16:17:57Z",    
    "notificationUrl": "https://91e383a5.ngrok.io/api/webhook/handlerequest",
    "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
}

URL-ÜberprüfungURL validation

Bevor ein neues Abonnement erstellt wird, sendet SharePoint eine Anforderung mit einem Überprüfungstoken im Textkörper der Anfrage an die bereitgestellt Dienst-URL.Before a new subscription is created, SharePoint sends a request with a validation token in the body of the request to the service URL provided. Ihr Dienst muss auf diese Anforderung durch Zurückgeben des Überprüfungstokens antworten.Your service must respond to this request by returning the validation token.

Wenn der Dienst die Anforderung auf diese Weise nicht überprüfen kann, wird das Abonnement nicht erstellt.If your service fails to validate the request in this way, the subscription is not created.

Weitere ArtikelSee also