OData in SAP Gateway - Feature Overview
SAP Gateway supports the following OData features:
OData |
Feature |
Description |
Available as of |
|---|---|---|---|
Format |
ATOM |
Atom is an XML-based document format that describes lists of related information known as feeds. |
SAP Gateway Release 2.0 Support Package 03 |
Format |
ATOM — literal representation |
Literal representation of primitive types must be used in OData URI or HTTP header. |
SAP Gateway Release 2.0 Support Package 03 |
Format |
ATOM — Feed customization (FC_TargetPath only) |
A service may represent the value of an entry property as the value of a standard Atom element (for example, title, summary). |
SAP Gateway Release 2.0 Support Package 03 |
Format |
JSON |
JavaScript Object Notation (JSON) is a lightweight data interchange format based on a subset of the JavaScript Programming Language standard. |
SAP Gateway Release 2.0 Support Package 04 |
Format |
OpenSearch description |
The OpenSearch description document format can be used to describe a search engine so that it can be used by search client applications. |
SAP Gateway Release 2.0 Support Package 04 |
Operations |
HTTP Status Code |
Control HTTP status code in exceptional case in data provider class. |
SAP Gateway Release 2.0 Support Package 05 |
Operations |
CRUD |
HTTP Post, Get, Updated and Delete requests on resources. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Read - Media Resources |
Read a binary association to a media link entry. The media link entry can either point to an internal binary in a table, for example, or to an external link that must be set in the data provider. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
CUD - Media Resources |
Create, Update, and Delete media resources associated with a media link entry. |
SAP Gateway Release 2.0 Support Package 04 |
Operations |
Concurrency Control and eTag (e.g. If-Match, If-None-Match) |
HTTP ETags are used for concurrency control. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Batch Handling |
Batch requests allow the grouping of multiple operations into a single HTTP request payload. See also Processing. |
SAP Gateway Release 2.0 Support Package 04 |
Operations |
Repeatable Requests / Idempotency |
Any kind of operation which can be repeated by providing a request ID. A repeated request is processed by the idempotency framework (fallback), for example, a create action not performed twice. See also Settings for Idempotent Services. |
SAP Gateway Release 2.0 Support Package 05 |
Operations |
Patch |
An operation to perform a partial update which contains just a subset of the entry's properties. |
SAP Gateway Release 2.0 Support Package 05 |
Operations |
Deep Insert |
An operation to create an entity with deep data in an in-lined format, for example, to create a parent/child relationship simultaneously. See also Deep Insert. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Expand |
URI with a $expand system query option indicates that entries associated with the entry or collection of entries identified by the resource path section of the URI must be represented inline. See also Expand in Data Provider and Framework. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Function Imports with Return Type Entry, Feed ComplexType |
Service operations represent functions exposed by an OData service. These functions may accept zero or more primitive type parameters. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Function Import with Return Type Collection of Complex Types |
Function imports with return type collection of complex types. |
SAP Gateway Release 2.0 Support Package 03 |
Operations |
Merge / Patch |
Update request sent via HTTP method MERGE / PATCH indicates that a subset of the entry's properties is sent to the server and should be merged with those fields that are not present in the request. See also Patch Support. |
SAP Gateway Release 2.0 Support Package 05 |
Paging ($top, $skip) |
The $top and $skip system query option identifies a subset of the entries in the collection of entries. |
SAP Gateway Release 2.0 Support Package 03 |
|
Query Options |
$filter |
The $filter system query option identifies a subset of the entries in the collection of entries. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
$count (handled by OData Channel (ODC) - not populated to data provider class (DPC) API) |
The $count system query option specifies that the request response contains a count of the number of entries in the collection only. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
$count (populated to DPC API) |
The $count system query option specifies that the request response contains a count of the number of entries in the collection only. |
SAP Gateway Release 2.0 Support Package 05 |
Query Options |
$orderby |
The $orderby system query option specifies an expression for determining what values are used to order the collection of entries. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
$select populated to DPC API |
The value of $select specifies that a response from an OData service should return a subset of the properties of the collection of entries. |
SAP Gateway Release 2.0 Support Package 04 |
Query Options |
$select (handled by ODC generically) |
The value of $select specifies that a response from an OData service should return a subset of the properties of the collection of entries. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
$links (read only; handled by ODC) |
The $links option specifies that the response to the request contains the links between an entry and an associated entry or a collection of entries. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
Read property - value, raw value ($value) and complex property |
OData provides two ways of exposing individual properties, one that follows OData formats and another that exposes the property's raw value. |
SAP Gateway Release 2.0 Support Package 03 |
Query Options |
$inlinecount=allpages |
A URI with a $inlinecount system query option specifies that the response to the request includes a count of the number of entries in the collection of entries. |
SAP Gateway Release 2.0 Support Package 04 |
Query Options |
$skiptoken (server-driven paging) |
The request response contains an <atom:link rel="next"> element for partial representations of the collection of entries. |
SAP Gateway Release 2.0 Support Package 04 |
SAP-Specific Extensions/Features |
Multiple origin / multi destination (origin segment parameter) |
A service may need to connect to several backend systems. The server adds an additional key to the collection of entries, which indicates the original system. In addition, the server defines strategies to deal with implicit and explicit CREATE requests. See also Multiple Origin Composition. |
SAP Gateway Release 2.0 Support Package 03 |
SAP-Specific Extenstions/Features |
Multiple origin / multi destination (parallelization) |
A service may need to connect to multiple backend systems and the backend calls are done in parallel. See also Multiple Origin Composition. |
SAP Gateway Release 2.0 Support Package 05 |
SAP-Specific Extensions/Features |
Versioning (segment parameter) |
A segment parameter in the URI of the service, for example, /myservice;v=2 may indicate a request to a specific service version. In addition, the SAP Gateway Catalog Service offers a function import for version negotiation between the client and the server. |
SAP Gateway Release 2.0 Support Package 04 |
SAP-Specific Extensions/Features |
Conversion Handling |
Conversions done in ABAP are handled implicitly for some conversion routines such as for currencies (based on metadata extracted from the ABAP Data Dictionary) or explicitly by the application developer if required. See also Conversion Handling in OData Channel. |
SAP Gateway Release 2.0 Support Package 03 Also available for Compatibility Mode for SP02 |
SAP-Specific Extensions/Features |
Error messages - Micro Format |
The error response to a request can be influenced by the developer and, if required, a detailed error description can be provided in a micro format. This is only possible for ATOM format. |
SAP Gateway Release 2.0 Support Package 03 |
SAP-Specific Extensions/Features |
XSRF token-based protection mechanism |
The protection XSRF attacks is ensured via a token-based exchange mechanism in the HTTP request/response header between the client and the server. See also Cross-Site Request Forgery Protection. |
SAP Gateway Release 2.0 Support Package 03 |
