Compartilhar via

Referência de API REST do BCS para SharePoint

  • Artigo

Biblioteca de classe e referências

Contém informações de referência para construir URLs REST (Transferência de Estado Representacional) para acessar e manipular fontes de dados externas usando o BCS (Business Connectivity Services) no SharePoint.

Usando APIs RESTful para acessar dados externos no SharePoint

A interface REST fornecida pelo SharePoint permite que você acesse a maioria dos recursos do SharePoint por meio de URLs especialmente construídas. Business Connectivity Services (BCS) usa essa arquitetura para fornecer acesso a dados externos.

Você pode acessar dados externos com URLs construindo exatamente como faria para acessar itens de lista padrão.

Observação

[!OBSERVAçãO] Acesso a essas entidades diretamente no BDC não for fornecido. Para trabalhar com dados externos, você deve criar uma lista externa e usar as URLs do REST para acessar os itens da lista contidos na lista externa.

Os verbos HTTP com suporte para trabalhar com listas externas são GET, PUT, POSTe DELETE.

Ao contrário com listas normais, é possível criar uma lista externa usando REST. Você deve fazer isso criando um modelo BDC e uma lista externa usando Visual Studio 2012.

As informações na tabela 1 mostram como construir URLs por REST e as chamadas de modelo de objeto cliente correspondente para acessar e manipular dados de fontes de dados externos.

Tabela 1. Formatos de URL RESTful para acessar dados externos

URL Descrição Método HTTP
http://[sharepointsite]/_api
A base de qualquer solicitação REST. O diretório virtual do _api é mapeado para ligar para client.svc, onde o modelo de objeto do cliente pode ser usado.
Get
http://[sharepointsite]/_api/web/title
Recupera o título da web atual.
Get
http://[sharepointsite]/_api/lists
Recupera todas as listas em um site.
Get
http://[sharepointsite]/_api/lists/getbytitle('listname')
Recupera os metadados para uma lista especificada.
Get
http://[sharepointsite]/_api/lists/getbytitle('listname')/items
Recupera os itens da lista em uma lista especificada.
Get
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title
Recupera o título de uma lista específica.
OBTER

Construindo strings de consulta para filtrar dados

Para limitar a quantidade de dados retornados, ou torná-lo mais relevantes para o usuário, você pode usar as operações de filtro encontradas na tabela 2.

Tabela 2. Operadores para filtrar dados

Operator Descrição
EQ
 Igual a
Observação: quando você usa o EQ para filtrar, os critérios de filtro são passados para o sistema externo em que a filtragem acontece no servidor.
GT
 Maior que
Observação: quando você usa o operador GT , somente a filtragem do lado do cliente é executada.> Por exemplo: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 retorna todos os títulos com uma classificação média acima de 3.

Observação

[!OBSERVAçãO] Para recuperar as colunas que fazem parte de uma associação, você deve incluir explicitamente a coluna na URL usando $select na seqüência de consulta.

Confira também