Conheça o serviço REST do SharePoint

O SharePoint inclui um serviço REST (Representational State Transfer) comparável aos modelos de objetos de cliente existentes no SharePoint. Agora, os desenvolvedores podem interagir remotamente com dados do SharePoint usando qualquer tecnologia que ofereça suporte a solicitações Web do REST. Isso significa que os desenvolvedores podem executar operações Criar, Ler, Atualizar e Excluir (CRUD) de seus suplementos, soluções e aplicativos cliente do SharePoint, usando tecnologias da Web REST e sintaxe OData (protocolo de Dados Abertos) padrão.

Pré-requisitos

Este tópico pressupõe que você tenha familiaridade básica com o REST e como construir solicitações REST.

Como funciona o serviço REST do SharePoint

O SharePoint agregou a capacidade de interagir remotamente com sites do SharePoint usando REST. Agora você pode interagir diretamente com objetos do SharePoint usando qualquer tecnologia que ofereça suporte a recursos padrão REST.

Para acessar os recursos do SharePoint usando o REST, construa uma solicitação HTTP RESTful, usando o padrão OData que corresponda à API do modelo de objeto cliente desejado. Por exemplo:

var items = List.GetByTitle(listname).GetItems();

GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

O serviço web client.svc no SharePoint manipula a solicitação HTTP e oferece a resposta apropriada no formato Atom ou no formato JSON (JavaScript Object Notation). Seu aplicativo cliente, em seguida, deverá analisar essa resposta. A figura a seguir mostra uma visão de alto nível da arquitetura REST do SharePoint.

Arquitetura do serviço REST do SharePoint

Devido à funcionalidade e à facilidade de uso dos modelos de objeto cliente, eles continuam como a principal opção de desenvolvimento para comunicação com os sites do SharePoint usando .NET Framework, Silverlight (agora substituído) ou JavaScript (JSOM).

Usar comandos HTTP com o serviço REST do SharePoint

Para usar os recursos REST internos ao SharePoint, crie uma solicitação HTTP RESTful, usando o padrão OData, que corresponde à API do modelo de objeto cliente que você deseja usar. O serviço Web client.svc manipula a solicitação HTTP e fornece uma resposta ou no formato Atom ou no JSON. O aplicativo cliente, em seguida, deverá analisar essa resposta.

Os pontos de extremidade no serviço REST do SharePoint correspondem aos tipos e membros nos modelos de objeto do cliente do SharePoint. Usando solicitações HTTP, você pode usar esses pontos de extremidade REST para executar operações CRUD típicas em relação a entidades do SharePoint, como listas e sites.

Construir URLs REST para acessar recursos do SharePoint

Sempre que possível, o URI desses pontos de extremidade REST simula de forma próxima a assinatura API do recurso no modelo de objeto cliente do SharePoint. Os pontos de entrada principais do serviço REST representam o conjunto de sites e o site do contexto especificado.

Para acessar um conjunto de sites específico, use a seguinte construção:

https://{site_url}/_api/site

Para acessar um site específico, use a seguinte construção:

https://{site_url}/_api/web

Em cada caso, server representa o nome do servidor e site representa o nome ou o caminho para o site específico.

Nesse ponto inicial, você pode construir URIs REST mais específicas “percorrendo” o modelo de objeto usando os nomes das APIs do modelo de objeto do cliente separadas por uma barra (/).

Essa sintaxe não se aplica às APIs REST SocialFeedManager ou SocialFollowingManager. Para saber mais, confira:

• Referência de API REST de feed social para o SharePoint
• Referência de API REST de seguir pessoas e conteúdo para o SharePoint

Consulte Determinar URIs de ponto de extremidade do serviço REST do SharePoint para obter mais diretrizes para determinar URIs de ponto de extremidade do REST do SharePoint na assinatura das APIs de modelo de objeto cliente correspondente.

Exemplos de ponto de extremidade REST do SharePoint

A tabela a seguir contém exemplos de URL de ponto de extremidade REST comuns para que você comece a trabalhar com dados do SharePoint. Coloque http://server/site/_api/ antes dos fragmentos de URL mostrados na tabela para construir uma URL REST totalmente qualificada. Onde necessário para comandos POST, a tabela contém dados de amostra que você precisa passar no corpo da solicitação HTTP para criar o item do SharePoint especificado. Itens entre aspas representam variáveis que você precisa substituir com seus valores.

Exemplo de Cria uma lista :

{
  "__metadata": {
    "type": "SP.List"
  },
  "AllowContentTypes": true,
  "BaseTemplate": 104 ,
  "ContentTypesEnabled": true,
  "Description": "My list description ",
  "Title": "RestTest "
}

Exemplo de Adiciona um item a uma lista:

{
  "__metadata": {
    "type": "SP.Data.listname.ListItem"
  },
  "Title": "MyItem"
}

No JSON acima, substitua ListName pelo nome da sua lista do SharePoint omitindo os espaços.

Suporte ao trabalho em lotes

O serviço REST do SharePoint Online (e o SharePoint 2016 no local ou posterior) dá suporte à combinação de várias solicitações em uma única chamada para o serviço usando a opção de consulta $batch do OData. Para obter detalhes e links de amostras de código, confira Fazer solicitações em lote com APIs REST.

Recursos do OData

• Desenvolvendo aplicativos orientados a serviços com o WCF
• Protocolo Open Data
• Convenções de URI do OData Protocol
• Operações de serviço de endereçamento
• Operações de OData Protocol
• Condições de erro

Tópicos do serviço REST do SharePoint

Use os recursos listados abaixo para saber mais sobre como usar o serviço REST do SharePoint.