Pioneering the next step.
SAP Gold Partner

Insights

OData einfach erklärt: Protokoll, Beispiele und V2 vs. V4

oData-Protokoll im Überblick: Funktionsweise und Beispiele
Simon Dietrich, SAP Developer
Simon Dietrich
SAP Developer
23. März 2023
OData einfach erklärt: Protokoll, Beispiele und V2 vs. V4

OData (Open Data Protocol) ist ein offener Standard für REST-Schnittstellen. Ein OData-Service stellt Daten unter festen URLs bereit, beschreibt sein Datenmodell unter $metadata und versteht Abfrageoptionen wie $filter oder $expand. Microsoft hat OData entwickelt, seit 2014 ist Version 4.0 ein OASIS-Standard. SAP nutzt OData für SAP Fiori und SAP S/4HANA.

Inhalt

Das Wichtigste in Kürze:

  • OData (Open Data Protocol) ist ein OASIS-Standard für REST-Schnittstellen. Version 4.0 ist zusätzlich als ISO/IEC 20802 genormt.
  • Ein OData-Service beschreibt sich selbst: Unter $metadata steht sein Datenmodell maschinenlesbar bereit.
  • Abfrageoptionen wie $filter, $select, $expand, $orderby und $top funktionieren in jedem OData-Service gleich.
  • OData V4 hat ein schlankeres JSON-Format und mehr Abfragemöglichkeiten als V2. SAP empfiehlt V4 für neue SAP Fiori elements-Apps.
  • SAP Gateway und das ABAP RESTful Application Programming Model stellen Daten aus SAP S/4HANA als OData-Services bereit.

Was ist OData?

OData steht für Open Data Protocol. Das Protokoll legt fest, wie REST-Schnittstellen gebaut und abgefragt werden: wie URLs aufgebaut sind, welche HTTP-Methode was bewirkt, wie Antworten im JSON-Format aussehen und welche Abfrageoptionen ein Service verstehen muss. Request- und Response-Header, Statuscodes, Payload-Formate und Abfragesyntax sind damit vorgegeben. Entwicklerinnen und Entwickler kümmern sich um die Geschäftslogik.

Die OASIS-Spezifikation beschreibt es so: Ein OData-Service veröffentlicht Ressourcen, die über URLs adressiert und in einem Entity Data Model (EDM) beschrieben sind. Clients lesen und bearbeiten diese Ressourcen mit einfachen HTTP-Nachrichten. Dazu kommen Funktionen und Aktionen für wiederverwendbare Logik, Batch-Anfragen und ab V4 eine Änderungsverfolgung (Delta), mit der ein Client nur geänderte Datensätze abholt.

Ein Vergleich aus der Werkstatt: OData ist für Schnittstellen, was ein genormtes Gewinde für Schrauben ist. Wer die Norm kennt, braucht nicht für jede Schraube ein eigenes Werkzeug. Wenn Sie eine OData-Abfrage schreiben können, fragen Sie SAP S/4HANA mit derselben Syntax ab wie jeden anderen OData-Service.

Wer hat OData entwickelt?

OData stammt ursprünglich von Microsoft. Im Mai 2012 schlugen Citrix, IBM, Microsoft, Progress Software, SAP und WSO2 ein Technisches Komitee für OData bei der Normungsorganisation OASIS vor. Microsoft brachte sieben Spezifikationsteile ein, die bis dahin unter dem Microsoft Open Specification Promise standen. Danach ging es so weiter:

  • 24. Februar 2014: OASIS verabschiedet OData Version 4.0 als Standard.
  • Februar 2017: ISO/IEC JTC 1 genehmigt OData 4.0 als ISO/IEC 20802-1:2016 (Protokoll) und ISO/IEC 20802-2:2016 (JSON-Format).
  • 23. April 2020: OASIS verabschiedet OData Version 4.01.

SAP gehört zu den Gründern des Komitees. Ralf Handl (SAP) war 2017 Co-Vorsitzender, 2020 teilte er den Vorsitz mit Michael Pizzo (Microsoft).

Wie funktioniert ein OData-Service?

Ein OData-Service ist eine Webadresse, hinter der Daten als Ressourcen liegen. Er nutzt HTTP (Hypertext Transfer Protocol) und folgt damit dem Client-Server-Prinzip: Der Client schickt eine Anfrage, der Server antwortet. HTTP ist zustandslos. Jede Anfrage steht für sich.

Ressourcen, Entitätsmengen und Navigation

Die Daten sind als Entitäten organisiert. Gleichartige Entitäten bilden eine Entitätsmenge (Entity Set), etwa alle Produkte oder alle Lieferanten. Jede Entität hat einen Schlüssel und ist darüber direkt erreichbar, zum Beispiel Products(1). Beziehungen heißen Navigationseigenschaften: Ein Produkt verweist auf seinen Lieferanten, ein Lieferant auf seine Produkte.

Servicedokument und $metadata

Jeder OData-Service hat zwei feste Einstiegspunkte. Das Servicedokument unter der Stamm-URL listet alle Entitätsmengen, Singletons und Funktionen. Das Metadatendokument unter $metadata beschreibt Typen, Schlüssel, Eigenschaften und Beziehungen in CSDL (Common Schema Definition Language). Menschen und Programme lesen diese Beschreibung gleichermaßen. SAP Fiori elements erzeugt aus Metadaten und Annotationen ganze Oberflächen. Ein gekürzter Auszug aus dem öffentlichen Beispieldienst von odata.org:

<EntityType Name="Product">
  <Key><PropertyRef Name="ID" /></Key>
  <Property Name="ID" Type="Edm.Int32" Nullable="false" />
  <Property Name="Name" Type="Edm.String" />
  <Property Name="Description" Type="Edm.String" />
  <Property Name="Rating" Type="Edm.Int16" Nullable="false" />
  <Property Name="Price" Type="Edm.Double" Nullable="false" />
  <NavigationProperty Name="Supplier" Type="ODataDemo.Supplier" Partner="Products" />
</EntityType>

Welche HTTP-Methoden nutzt OData?

Die Methode einer HTTP-Anfrage legt fest, was mit der Ressource passiert. GET und POST sind die häufigsten, für Änderungen kommen drei weitere dazu:

Methode Wirkung Beispiel
GET Daten lesen GET Products(1)
POST Neue Entität anlegen oder Aktion aufrufen POST Products
PATCH Einzelne Felder ändern PATCH Products(1)
PUT Entität vollständig ersetzen PUT Products(1)
DELETE Entität löschen DELETE Products(1)

OData V2 kennt zusätzlich MERGE für Teiländerungen, in V4 übernimmt PATCH diese Aufgabe. Mit $batch bündelt ein Client mehrere Anfragen in einem einzigen HTTP-Aufruf.

Jede Antwort enthält einen Statuscode und meist die eigentlichen Daten, die Payload. Die erste Ziffer zeigt die Richtung:

  • 1xx Information: Die Anfrage ist eingegangen, die Verarbeitung läuft weiter.
  • 2xx Erfolg: Die Aktion wurde empfangen, verstanden und angenommen, zum Beispiel 200 OK oder 201 Created nach einem POST.
  • 3xx Umleitung: Der Client muss einen weiteren Schritt gehen.
  • 4xx Client-Fehler: Die Anfrage hat eine falsche Syntax oder lässt sich nicht erfüllen.
  • 5xx Server-Fehler: Der Server konnte eine anscheinend gültige Anfrage nicht erfüllen.

Was hat OData mit REST zu tun?

REST (Representational State Transfer) ist der Architekturstil, auf dem OData aufbaut. REST arbeitet ressourcenbasiert, SOAP dagegen aktionsbasiert. In SOAP gibt es zum Beispiel eine Anfrage „Materialdaten abrufen“. Im REST-Modell ist das Material selbst die Ressource und über eine URI erreichbar. Die HTTP-Methode legt fest, welche Operation darauf läuft.

Der Client bekommt dabei eine Repräsentation der Ressource, etwa ein JSON-Dokument. Die Ressource selbst bleibt auf dem Server. Über die Repräsentation liest und ändert der Client ihren Zustand.

OData-Beispiele: Wie sehen Abfragen konkret aus?

Die vier Beispiele laufen gegen den öffentlichen Beispieldienst von odata.org in Version 4. Jede URL lässt sich direkt im Browser öffnen. Der Dienst enthält 11 Produkte mit den Feldern ID, Name, Description, ReleaseDate, DiscontinuedDate, Rating und Price. Produkte sind mit Lieferanten verknüpft. Die Stamm-URL lautet https://services.odata.org/V4/OData/OData.svc.

Beispiel 1: Alle Produkte abfragen

GET https://services.odata.org/V4/OData/OData.svc/Products?$select=ID,Name,Price

Ohne Zusatz liefert /Products alle Felder aller Produkte. Mit $select bleibt die Antwort übersichtlich. Antwort, gekürzt auf drei von elf Einträgen:

{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Products(ID,Name,Price)",
  "value": [
    { "ID": 0, "Name": "Bread", "Price": 2.5 },
    { "ID": 1, "Name": "Milk", "Price": 3.5 },
    { "ID": 2, "Name": "Vint soda", "Price": 20.9 }
  ]
}

Die Liste steht immer im Feld value. @odata.context verweist auf die passende Stelle im Metadatendokument.

Beispiel 2: Ein Produkt über seinen Schlüssel lesen

GET https://services.odata.org/V4/OData/OData.svc/Products(1)

Der Schlüssel steht in Klammern hinter der Entitätsmenge, hier ID = 1. Ein einzelnes Produkt kommt direkt als Objekt zurück:

{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Products/$entity",
  "ID": 1,
  "Name": "Milk",
  "Description": "Low fat milk",
  "ReleaseDate": "1995-10-01T00:00:00Z",
  "DiscontinuedDate": null,
  "Rating": 3,
  "Price": 3.5
}

Beispiel 3: Produkte filtern, sortieren und begrenzen

GET https://services.odata.org/V4/OData/OData.svc/Products?$filter=Rating eq 3&$orderby=Price desc&$top=2&$select=ID,Name,Price

Sieben Produkte haben das Rating 3. $orderby=Price desc sortiert sie absteigend nach Preis, $top=2 gibt nur die ersten zwei zurück:

{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Products(ID,Name,Price)",
  "value": [
    { "ID": 8, "Name": "LCD HDTV", "Price": 1088.8 },
    { "ID": 4, "Name": "Fruit Punch", "Price": 22.99 }
  ]
}

Weitere Varianten: $filter=Price lt 10 liefert alle Produkte unter 10, $filter=contains(Name,'Lemon') sucht im Namen. Mit $select=ID,Description enthält die Antwort nur die Felder ID und Description. Leerzeichen in der URL kodiert der Browser automatisch als %20. Die Optionen $search und $apply aus der Tabelle unten unterstützt der Beispieldienst nicht.

Beispiel 4: Vom Produkt zum Lieferanten navigieren

Laut Datenmodell ist ein Produkt über die Navigationseigenschaft Supplier mit einem Lieferanten verknüpft. So liefert der Service den Lieferanten zu Produkt 1:

GET https://services.odata.org/V4/OData/OData.svc/Products(1)/Supplier?$select=ID,Name
{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Suppliers(ID,Name)/$entity",
  "@odata.etag": "W/\"0\"",
  "ID": 0,
  "Name": "Exotic Liquids"
}

Brauchen Sie Produkt und Lieferant in einer Antwort, nutzen Sie $expand:

GET https://services.odata.org/V4/OData/OData.svc/Products(1)?$select=ID,Name&$expand=Supplier($select=ID,Name)
{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Products(ID,Name,Supplier(ID,Name))/$entity",
  "ID": 1,
  "Name": "Milk",
  "Supplier": {
    "@odata.etag": "W/\"0\"",
    "ID": 0,
    "Name": "Exotic Liquids"
  }
}

Die verschachtelte Option $select innerhalb von $expand gibt es erst seit OData V4.

Welche Abfrageoptionen gibt es?

Option Wirkung Beispiel
$filter Datensätze nach Bedingung auswählen $filter=Rating eq 3
$select Nur bestimmte Felder zurückgeben $select=ID,Name
$expand Verknüpfte Entitäten mitliefern $expand=Supplier
$orderby Sortieren, auf- oder absteigend $orderby=Price desc
$top, $skip Anzahl begrenzen und blättern $top=10&$skip=20
$count Trefferzahl mitliefern (V4) $count=true
$search Freitextsuche (V4, sofern der Service sie anbietet) $search=Milk
$apply Gruppieren und aggregieren (OASIS-Erweiterung Data Aggregation) $apply=groupby((Rating),aggregate($count as Anzahl))

OData V2 vs. V4: Was ist der Unterschied?

OData V2 ist die ältere Version und im SAP-Umfeld weit verbreitet. Viele SAP Fiori-Apps und SAP Gateway-Services basieren darauf. OData V4 ist der aktuelle OASIS-Standard. In ihn sind die Erfahrungen aus der intensiven Nutzung von V2 eingeflossen. Die wichtigsten Unterschiede:

Merkmal OData V2 OData V4
Status Spezifikation von Microsoft, veröffentlicht auf odata.org OASIS-Standard seit 2014 (4.01 seit 2020), ISO/IEC 20802
Datenformat Atom/XML und JSON; JSON-Antwort im Objekt „d“, Listen in „results“, Metadaten je Datensatz in „__metadata“ JSON als Hauptformat; Umfang der Metadaten steuerbar (full, minimal, none)
Trefferzahl $inlinecount=allpages, Ergebnis in „__count“ $count=true, Ergebnis in „@odata.count“
$expand Verknüpfte Entitäten mitliefern, ohne eigene Optionen Verschachtelt mit $filter, $select, $orderby, $top; $levels für rekursive Strukturen
Suchen und Filtern substringof() contains(), $search für Freitext; ab 4.01 in-Operator und $compute
Aggregation Bei SAP über eigene Annotationen, das Backend aggregiert $apply (Erweiterung Data Aggregation); der Client gibt Dimensionen und Kennzahlen an
Datum und Zeit Edm.DateTime, Edm.Time Edm.Date, Edm.TimeOfDay, Edm.Duration
Ändern PUT und MERGE PATCH bevorzugt, MERGE entfällt; Anlegen per PATCH oder PUT möglich (Upsert)
$batch Format multipart/mixed multipart/mixed, ab 4.01 zusätzlich JSON
Annotationen SAP-spezifische Attribute im Metadatendokument, etwa sap:label Standardisierte Vokabulare von OASIS und SAP (zum Beispiel UI, Common) in CSDL
Änderungsverfolgung Nicht im Standard enthalten Delta-Abfragen über die Präferenz odata.track-changes

Wie verschieden die Antworten aussehen, zeigt dieselbe Abfrage gegen die V2- und die V4-Fassung des Beispieldienstes:

GET https://services.odata.org/V2/OData/OData.svc/Products(1)?$select=ID,Name&$format=json

{
  "d": {
    "__metadata": {
      "id": "https://services.odata.org/V2/OData/OData.svc/Products(1)",
      "uri": "https://services.odata.org/V2/OData/OData.svc/Products(1)",
      "type": "ODataDemo.Product"
    },
    "ID": 1,
    "Name": "Milk"
  }
}
GET https://services.odata.org/V4/OData/OData.svc/Products(1)?$select=ID,Name

{
  "@odata.context": "https://services.odata.org/V4/OData/OData.svc/$metadata#Products(ID,Name)/$entity",
  "ID": 1,
  "Name": "Milk"
}

V4 verzichtet auf das Hüllobjekt „d“ und auf Metadaten in jedem Datensatz. Bei Listen summiert sich das: Alle elf Produkte mit ID und Name liefert die V2-Fassung in 1.821 Byte, die V4-Fassung in 500 Byte (abgerufen am 7. Oktober 2026).

Wie nutzt SAP OData?

Im SAP-Umfeld ist OData das Standardprotokoll für Oberflächen und für einen Großteil der Cloud-APIs. Eine eigene Zählung im SAP Business Accelerator Hub vom 7. Oktober 2026 zeigt die Größenordnung: Das Paket SAP S/4HANA Cloud Public Edition enthält 809 aktive APIs. 344 davon sind OData V4, 188 OData V2 und 277 SOAP. Knapp zwei von drei APIs sprechen also OData. Auch SAP Sales & Service Cloud und SAP SuccessFactors bieten OData-APIs an.

SAP Gateway

SAP Gateway stellt Funktionen und Daten aus ABAP-Systemen als OData-Services bereit. Technische Basis ist die Softwarekomponente SAP Gateway Foundation (SAP_GWFND) im ABAP-Stack. Sie unterstützt die gängigen Abfrageoptionen, Batch-Anfragen sowie die Formate Atom und JSON. Neben V2-Services kann SAP Gateway auch OData-V4-Services bereitstellen.

SAP Fiori und SAPUI5

SAP Fiori-Apps holen ihre Geschäftsdaten über OData-Services aus dem Backend. SAPUI5 bringt dafür ein OData-V2-Modell und ein OData-V4-Modell (sap.ui.model.odata.v4.ODataModel) mit, für das Lesen ebenso wie für das Anlegen und Ändern von Daten. Das V4-Modell bündelt Anfragen per Batch und überlässt Sortieren und Filtern dem Server. Für neue Entwicklungen ist die SAPUI5-Dokumentation eindeutig: „For new applications, we recommend using SAP Fiori elements for OData V4.“ Auch für das Datenmodell empfiehlt SAP einen OData-V4-Service, weil V4 von OASIS standardisiert ist und Funktionen hat, die V2 fehlen.

ABAP RESTful Application Programming Model (RAP)

Im ABAP RESTful Application Programming Model (RAP) entsteht ein OData-Service in drei Schritten. CDS-Views (Core Data Services) beschreiben das Datenmodell. Eine Service-Definition legt fest, welche Entitäten nach außen sichtbar sind. Das Service Binding bindet den Service an ein Protokoll: OData V2 oder OData V4, jeweils als UI-Service für SAP Fiori oder als Web-API für andere Systeme. Dasselbe RAP-Business-Objekt lässt sich so als V2 und als V4 veröffentlichen. Den Einstieg beschreibt unser Beitrag Einführung in das ABAP RESTful Application Programming Model (RAP).

SAP Business Accelerator Hub

Der SAP Business Accelerator Hub (api.sap.com) ist der Katalog für APIs aus SAP S/4HANA, SAP SuccessFactors, SAP Customer Experience und SAP BTP. Er führt REST-, OData- und SOAP-APIs mit Dokumentation und Metadaten. Nach der Anmeldung lassen sich Abfragen in einer Sandbox ausprobieren. Ein Detail am Rande: Der Katalog des Hubs ist selbst ein OData-V2-Service und antwortet im typischen „d“-Format.

Welche Schnittstelle für welchen Zweck passt und wie OData-Services aus SAP S/4HANA mit Cloud-Anwendungen zusammenspielen, ist Thema unseres Kompetenzfelds Autonomous Enterprise, Bereich SAP Business AI Platform & Integration.

Ist OData eine REST-API?

Ja. OData baut auf dem REST-Prinzip auf: Ressourcen unter URLs, HTTP-Methoden zum Lesen und Schreiben, zustandslose Anfragen. REST ist allerdings nur ein Architekturstil. OData legt zusätzlich URL-Konventionen, Abfrageoptionen, das JSON-Format und ein maschinenlesbares Metadatendokument fest. Jeder OData-Service ist damit eine REST-API. Umgekehrt ist längst nicht jede REST-API ein OData-Service.

OData oder SOAP: Was passt wann?

OData passt, wenn Anwendungen Daten flexibel lesen und ändern sollen, etwa SAP Fiori-Apps, Webshops oder mobile Apps. Der Client bestimmt per Abfrageoption, welche Felder und Datensätze er braucht. SOAP arbeitet mit fest definierten Operationen und XML-Nachrichten, beschrieben in einer WSDL-Datei. Das passt zu klar umrissenen Vorgängen zwischen Systemen, zum Beispiel dem Versand einer Frachtbuchung an einen Logistikdienstleister. Für SAP S/4HANA Cloud Public Edition sind 277 der 809 aktiven APIs im SAP Business Accelerator Hub SOAP-Services. Wie das im SAP-Umfeld funktioniert, zeigt unser Beitrag Schnittstelle SAP SOAP Web Service.

Was ist eine OData-Schnittstelle?

Eine OData-Schnittstelle ist ein Endpunkt, der das OData-Protokoll spricht. Im Sprachgebrauch ist damit meist ein OData-Service gemeint. Er besteht aus einer Stamm-URL, dem Servicedokument, dem Metadatendokument unter $metadata und den Entitätsmengen mit ihren Daten. In SAP-Systemen entsteht eine OData-Schnittstelle über SAP Gateway oder über ein Service Binding im ABAP RESTful Application Programming Model.

Lohnt sich der Wechsel von OData V2 auf V4?

Für neue Entwicklungen ja. SAP empfiehlt OData V4 für neue SAP Fiori elements-Apps, und 344 der aktiven APIs für SAP S/4HANA Cloud Public Edition im SAP Business Accelerator Hub sind bereits V4. V2 bleibt trotzdem im Einsatz: 188 aktive APIs dort nutzen weiterhin V2. Ein Umbau bestehender Services lohnt sich vor allem, wenn Sie Funktionen brauchen, die nur V4 hat, etwa verschachteltes $expand, $search oder Aggregation per $apply. In RAP veröffentlichen Sie dasselbe Business-Objekt über ein zusätzliches Service Binding als V4.

Stand: Oktober 2026

Quellen (Primärquellen)

Willkommen bei der CPRO Gruppe

Ihr bisheriger Anbieter ist jetzt CPRO. Sie wurden automatisch auf unsere neue Website weitergeleitet. Für Sie ändert sich nur der Markenauftritt: Ihre Verträge behalten ihre Gültigkeit, Ihre Ansprechpartner und die Gesellschaft als Ihr Vertragspartner bleiben unverändert. Wir freuen uns, Sie hier begrüßen zu dürfen!