Zugriff auf externe Daten mit REST in SharePoint

  • Artikel

Erfahren Sie, wie externe Daten mithilfe von Representational State Transfer (REST) URLs für Business Connectivity Services (BCS)SharePoint zugreifen. In diesem Artikel veranschaulicht, wie eine externe Liste einrichten, die Daten aus einer Open Data Protocol (OData) Datenquelle abruft.

Erforderliche Komponenten für den Zugriff auf externe Daten mithilfe von REST

Zugriff auf externe Daten aus SharePoint unter Verwendung von REST, benötigen Sie Folgendes:

Kernkonzepte beim Zugriff auf externe Daten mit REST

Der REST-Dienst SharePoint bietet eine Möglichkeit Zugriff auf externe Daten mithilfe einer speziell gestalteten URL. Funktionsweise und Ihre Verwendung finden Sie unter den folgenden Artikeln.

Tabelle 1. Kernkonzepte für REST in SharePoint

Titel des Artikels Beschreibung
Programmieren mit dem SharePoint REST-Dienst Erfahren Sie, wie den SharePoint-REST-Dienst verwenden, der eine Programmierschnittstelle vergleichbar mit der vorhandenen SharePoint-Clientobjektmodell REST bietet.
Erste Schritte mit den SharePoint REST-Dienst Hier erhalten Sie grundlegende Informationen zum Verwenden des SharePoint REST-Diensts zum Zugreifen auf und Aktualisieren von SharePoint-Daten mithilfe der REST- und OData-Webprotokollstandards.
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint REST-Endpunkten Erfahren Sie, wie die SharePoint-Datenstruktur dargestellt in der REST-Dienst zu navigieren, führen Sie allgemeine CRUD (erstellen, lesen, aktualisieren und löschen)-Vorgänge zu SharePoint-Elemente über den REST-Dienst Synchronisieren von SharePoint-Elemente anwendungsübergreifend und Element Parallelität steuern.

Erstellen einer SharePoint-Add-In zum Zugreifen auf externe Daten mithilfe von REST

Die folgenden Schritte führen Sie durch eine SharePoint-Add-In einrichten und Konfigurieren von einer Webseite zum Verwenden von REST-Funktionen zum Abrufen von Daten aus einer externen Datenquelle anzufordern.

Erstellen einer SharePoint-Add-In

  1. Öffnen Sie Visual Studio 2012 oder höher.
  2. Erstellen einer App für SharePoint-Projekt.
  3. Geben Sie die Appeinstellungen, einschließlich app-Name die URL der Website für das Debuggen der app und wie Sie die app (automatisch gehostet, vom Anbieter gehosteten, SharePoint-Hosting) hosten möchten. Weitere Informationen zu Hostingoptionen finden Sie unter Auswählen von Mustern zum Entwickeln und Hosten Ihres SharePoint-Add-Ins.
  4. Wählen Sie auf Fertig stellen, um die app zu erstellen.

Um den externen Inhaltstyp zu generieren.

  1. Öffnen Sie im Projektmappen-Explorerdas Kontextmenü für das Projekt, und wählen Sie Hinzufügen und Inhaltstypen für externe Datenquelle aus.

  2. OData-Quelle geben Sie auf der Seite Geben Sie die URL der OData-Dienst, den, dem Sie mit verbinden möchten. In diesem Fall verwenden Sie die Northwind-OData-Quelle auf https://www.odata.org/ecosystemveröffentlicht. Legen Sie die URL für den OData-Dienst auf fest http://services.odata.org/Northwind/Northwind.svc/, und geben Sie einen Namen für die Datenquelle an.

    Wählen Sie Weiter aus.

  3. Dadurch wird eine Liste aller Datenentitäten, die vom OData Service verfügbar gemacht werden. Wählen Sie die Kunden-Entität. Stellen Sie sicher, dass das Kontrollkästchen für die ausgewählten Datenentitäten (mit Ausnahme von Dienstvorgänge) Listeninstanzen erstellen ausgewählt ist.

  4. Wählen Sie Fertig stellen aus.

Codebeispiel: Hinzufügen von Skripts und HTML auf der Seite Home.aspx

Zu diesem Zeitpunkt haben Sie einen externen Inhaltstyp und eine externe Liste, in der die Daten aus der Northwind OData-Quelle angezeigt werden.

Nächste Ziel ist es, die Seite "default.aspx" zu ändern, die erstellt wurde, wenn Sie Ihre app erstellt haben. Fügen Sie einen Container zum Speichern der Ergebnisse der Abfrage, die mit Laden der Seite ausgeführt wird. Durch Ausführen des Skripts auf der Seite Load-Ereignis, stellen Sie sicher, dass das Skript ausgeführt wird, jedes Mal wird die Seite durchsucht, und die resultierenden REST-Aufrufe auf die Northwind OData-Quelle erfolgen Datensätze auf der Seite hinzufügen.

So fügen Sie dem Container zur Seite Default.aspx hinzu

  1. Öffnen Sie im Projektmappen-Explorer die Seite "Default.aspx" im Modul Seiten.
  2. Fügen Sie das folgende div Element auf der Seite.
<div id="displayDiv"></div>
  1. Speichern Sie die Seite.

Zum Schluss fügen Sie Code auf die Datei App.js, die beim Laden der Seite ausgeführt.

So ändern Sie die Datei App.js REST-Anrufe

  1. Öffnen Sie die App.js-Datei im Modul Skripts Ihres SharePoint-Projekts.
  2. Fügen Sie den folgenden Code am Ende der Datei.
$(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();
}

Drücken Sie F5, um die app in SharePoint bereitstellen. Wechseln Sie zur Seite Default.aspx in der app, und eine Liste der Kunden wird auf der Seite angezeigt.

Siehe auch