Partilhar via

Obter assinaturas

  • Artigo

Obtém uma ou mais assinaturas de webhook em uma lista do SharePoint.

Permissões

Obter uma assinatura única

O aplicativo deve ter pelo menos permissões de edição para a lista do SharePoint em que a assinatura será recuperada.

Se o aplicativo for um aplicativo do Microsoft Azure AD (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.

Aplicativo Permissão
Office 365 SharePoint Online Ler e gravar listas e itens em todos os conjuntos de sites.

Se o aplicativo for um suplemento do SharePoint

Você deve conceder ao suplemento do SharePoint as permissões a seguir ou superiores. Uma assinatura só pode ser recuperada pelo suplemento do SharePoint que a criou.

Escopo Direitos de permissão
Listar Gerenciar

Obter todas as assinaturas

O aplicativo deve ter permissões de gerenciamento de lista na lista do SharePoint em que a assinatura será recuperada.

Se seu aplicativo for um Azure AD aplicativo

Você deve conceder ao aplicativo do Azure AD as permissões especificadas na tabela a seguir.

Aplicativo Permissão
Office 365 SharePoint Online Tem controle total de todos os conjuntos de sites.

Se o aplicativo for um suplemento do SharePoint

Você deve conceder ao suplemento do SharePoint as permissões a seguir ou superiores.

Escopo Direitos de permissão
Listar Controle total

Solicitação HTTP

Obter uma assinatura única

Listar webhook

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

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Isso retornará a assinatura visível pelo aplicativo de chamada.

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

Obter todas as assinaturas

Listar webhook

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

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Isso retorna uma coleção de todas as assinaturas de um recurso do 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"
    }
  ]
}

Confira também