Inhaltsverzeichnis

2.1 OData Basics

OData1) (Open Data Protocol) is a REST2)-based standard for data queries, developed by OASIS3).

Why OData?

OData Version

The Data Gateway supports OData v4.016).

Service Document

GET /odata/demo

Lists all available Entity Sets (tables/views).

Metadata

GET /odata/demo/$metadata

Returns the schema in EDMX7) format.

Query Entity Set

GET /odata/demo/Customers
GET /odata/demo/Customers?$top=10
GET /odata/demo/Customers?$filter=Country eq 'Germany'

Query Options

Option Description Example
$filter Filter results $filter=Price gt 100
$select Select columns $select=Name,Price
$orderby Sort results $orderby=Name desc
$top Limit count $top=10
$skip Skip entries $skip=20
$count Count results $count=true
$expand Load relationships $expand=Orders

Further Reading

Sources

1)
OData - Open Data Protocol: https://www.odata.org/
2)
Representational State Transfer: https://en.wikipedia.org/wiki/Representational_state_transfer
3)
OASIS Open: https://www.oasis-open.org/
4)
OData Query Options: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html
5)
Common Schema Definition Language: https://docs.oasis-open.org/odata/odata-csdl-json/v4.01/odata-csdl-json-v4.01.html
6)
OData Version 4.01 Specification: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html
7)
Entity Data Model XML: https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html