Serviço REST do SharePoint
O SharePoint inclui um serviço REST (Transferência de Estado Representacional) que é comparável aos modelos de objeto do cliente existentes do SharePoint. Agora, os desenvolvedores podem interagir remotamente com os dados do SharePoint usando qualquer tecnologia que dê suporte a solicitações da Web REST. Essencialmente, os desenvolvedores podem executar operações CRUD (criação, leitura, atualização e exclusão ) de seus suplementos, soluções e aplicativos cliente do SharePoint usando tecnologias da Web REST e sintaxe OData (Protocolo Open Data) padrão.
Como funciona o serviço REST do SharePoint
O SharePoint adiciona a capacidade de interagir remotamente com sites do SharePoint usando REST. Agora, você pode interagir diretamente com objetos do SharePoint usando qualquer tecnologia que dê suporte a funcionalidades REST padrão.
Para acessar os recursos do SharePoint usando REST, você pode criar uma solicitação HTTP RESTful usando o padrão OData, que corresponde à API do modelo de objeto do cliente desejada, conforme mostrado no seguinte exemplo:
GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Usar comandos HTTP com o serviço REST do SharePoint
Para usar as funcionalidades REST que são integradas ao SharePoint, você pode criar uma solicitação HTTP RESTful usando o padrão OData, que corresponde à API do modelo de objeto do cliente que deseja usar. O serviço Web client.svc lida com a solicitação HTTP e fornece a resposta apropriada no formato Atom ou JSON. Em seguida, o aplicativo cliente deve analisar essa resposta.
Os pontos de extremidade no serviço REST do SharePoint correspondem aos tipos e aos 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.
A tabela a seguir fornece uma visão geral das solicitações HTTP.
| Ação | Solicitação HTTP | Lembre-se |
|---|---|---|
| Ler um recurso | GET | Talvez seja necessário modificar o formato dos dados retornados. |
| Criar ou atualizar um recurso | POST | Use POST para criar entidades como listas e sites. O serviço REST do SharePoint dá suporte ao envio de comandos POST que incluem definições de objeto para pontos de extremidade que representam coleções. Para operações POST, as propriedades que não são necessárias são definidas com seus valores padrão. Se você tentar definir uma propriedade somente leitura como parte de uma operação POST, o serviço retornará uma exceção. |
| Atualizar ou inserir um recurso | PUT | Use as operações PUT e MERGE para atualizar os objetos do SharePoint existentes. Qualquer ponto de extremidade de serviço que representa uma operação de conjunto de propriedades de objeto dá suporte a solicitações PUT e MERGE. Para solicitações MERGE, é opcional definir as propriedades; as propriedades que você não define explicitamente mantêm sua propriedade atual. Para solicitações PUT, se você não especificar todas as propriedades necessárias nas atualizações de objeto, o serviço REST retornará uma exceção. Propriedades opcionais que você não especifica explicitamente são definidas como suas propriedades padrão. |
| Excluir um recurso | DELETE | Use o comando HTTP DELETE na URL do ponto de extremidade específico para excluir o objeto do SharePoint representado por esse ponto de extremidade. Estão disponíveis objetos recicláveis, como listas, arquivos e itens de lista, o que resulta em uma operação de reciclagem. |
Criar URLs REST para acessar recursos do SharePoint
O SharePoint usa APIs REST. Uma API é um intermediário de software que permite que dois aplicativos se comuniquem. Sempre que usa um aplicativo em seu telefone para verificar o clima, você está usando uma API.
Para criar pontos de extremidade de serviço REST do SharePoint, siga estas etapas:
Comece com a referência do serviço REST:
https://{site_url}/_apiEspecifique o ponto de entrada apropriado, por exemplo:
https://{site_url}/_api/webExemplo:
https://contoso.sharepoint.com/_api/webVá do ponto de entrada para os recursos específicos que você deseja acessar, inclusive a especificação de parâmetros para ponto de extremidades que correspondem aos métodos no modelo de objeto do cliente, por exemplo:
https://{site_url}/_api/web/lists/getbytitle('list_name')Exemplo:
https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')