Compartilhar via

Acessar dados externos usando REST no SharePoint

  • Artigo

Saiba como acessar dados externos do SharePoint usando as URLs de Transferência de Estado Representacional (REST) para Serviços Corporativos de Conectividade (BCS). Este artigo mostra como configurar uma lista externa que recupera dados de uma fonte de Protocol Open Data (OData).

Pré-requisitos para acessar dados externos usando o REST

Para acessar dados externos do SharePoint usando REST, você precisará dos seguintes itens:

Principais conceitos a saber ao acessar dados externos com REST

O serviço de REST do SharePoint fornece uma maneira de acessar dados externos usando uma URL especialmente construída. Para entender como ele funciona e como usá-lo, confira os artigos a seguir.

Tabela 1. Conceitos principais para REST no SharePoint

Título do artigo Descrição
Usar operações de consulta OData em solicitações REST do SharePoint Saiba como usar o serviço de REST do SharePoint, que fornece uma interface de programação de REST comparável ao modelo de objeto de cliente existente.
Conheça o serviço REST do SharePoint Obtenha as noções básicas de uso do serviço REST do SharePoint para acessar e atualizar dados do SharePoint usando os padrões de protocolo REST e OData web.
Realizar operações básicas usando os pontos de extremidade REST do SharePoint Saiba como navegar entre a estrutura de dados SharePoint conforme é representada no serviço REST, execute operações CRUD (criar, ler, atualizar e excluir) comuns em itens do SharePoint por meio do serviço REST, sincronize itens do SharePoint em todos os aplicativos e controle a simultaneidade de item.

Criar um suplemento do SharePoint para acessar dados externos usando REST

Os procedimentos a seguir orientam você por meio de um Suplemento do SharePoint definir e configurar a uma página da Web para tornar solicitações usando funções REST para recuperar dados de uma fonte de dados externa.

Criar um Suplemento do SharePoint

  1. Abra o Visual Studio 2012 ou posterior.
  2. Crie um projeto de Aplicativo para o SharePoint.
  3. Specify the app settings, including app name, the site URL for debugging the app, and how you want to host the app (Autohosted, Provider-hosted, SharePoint-hosted). Para obter mais informações sobre opções de hospedagem, confira Escolher padrões para desenvolver e hospedar seu Suplemento do SharePoint.
  4. Escolha Concluir para criar o aplicativo.

Gerar o tipo de conteúdo externo

  1. No Solution Explorer, abra o menu de atalho para o projeto e escolha Adicionar, Tipos de conteúdo para a fonte de dados externa.

  2. Na página Especificar a fonte do OData, insira a URL do serviço OData que você deseja se conectar. Nesse caso, use a fonte Northwind OData publicada em https://www.odata.org/ecosystem. Defina a URL do serviço OData como http://services.odata.org/Northwind/Northwind.svc/e forneça um nome para a fonte de dados.

    Escolha OK.

  3. Isso exibe uma lista de entidades de dados que estão sendo expostos pelo OData Service. Selecione a entidade de clientes. Certifique-se de que a caixa de seleção criar instâncias de lista para as entidades de dados selecionada (exceto as operações de serviço) está marcada.

  4. Escolha Concluir.

Exemplo de código: adicionar scripts e HTML na página Home.aspx

Neste ponto, você tem um tipo de conteúdo externo e uma lista externa que exibirá os dados da fonte de OData Northwind.

O próximo objetivo é modificar a página default.aspx criada quando você criou seu aplicativo. Você adicionará um contêiner para manter os resultados da consulta executada com as cargas da página. Executando os scripts no evento de carregamento de página, verifique se o script é executado sempre que a página é navegada e as chamadas REST resultantes são feitas à fonte Northwind OData para adicionar registros à página.

Adicionar o contêiner à página Default.aspx

  1. No Solution Explorer, abra a página Default. aspx no módulo páginas.
  2. Adicione o seguinte elemento div à página.
<div id="displayDiv"></div>
  1. Salve a página.

Finalmente, você deve adicionar código para o arquivo App.js que é executado quando a página for carregada.

Modificar o arquivo App.js para fazer chamadas REST

  1. Abra o arquivo App.js no módulo Scripts do projeto do SharePoint.
  2. Cole o seguinte código no final do arquivo.
$(document).ready(function () {

  // Namespace
  window.AppLevelECT = window.AppLevelECT || {};

  // Constructor
  AppLevelECT.Grid = function (hostElement, surlWeb) {
      this.hostElement = hostElement;
      if (surlWeb.length > 0 &amp;&amp; surlWeb.substring(surlWeb.length - 1, surlWeb.length) != "/")
          surlWeb += "/";
      this.surlWeb = surlWeb;
  }

  // Prototype
  AppLevelECT.Grid.prototype = {

      init: function () {

          $.ajax({
              url: this.surlWeb + "_api/lists/getbytitle('Customer')/items?$select=BdcIdentity,CustomerID,ContactName",
              headers: {
                  "accept": "application/json",
                  "X-RequestDigest": $("#__REQUESTDIGEST").val()
              },
              success: this.showItems
          });
      },

      showItems: function (data) {
          var items = [];

          items.push("<table>");
          items.push('<tr><td>Customer ID</td><td>Customer Name</td></tr>');

          $.each(data.d.results, function (key, val) {
              items.push('<tr id="' + val.BdcIdentity + '"><td>' +
                  val.CustomerID + '</td><td>' +
                  val.ContactName + '</td></tr>');
          });

          items.push("</table>");

          $("#displayDiv").html(items.join(''));
      }
  }

  ExecuteOrDelayUntilScriptLoaded(getCustomers, "sp.js");
});

function getCustomers() {
    var grid = new AppLevelECT.Grid($("#displayDiv"), _spPageContextInfo.webServerRelativeUrl);
    grid.init();
}

Pressione F5 para implantar o aplicativo no SharePoint. Navegue até a página Default.aspx no aplicativo e uma lista de clientes aparece na página.

Confira também