Show TOC

Enabling REST Services as OData ServicesLocate this document in the navigation structure

Enabling REST services as OData services using Integration Gateway.


Integration Gateway lets you to expose Representational State Transfer (REST) services (both SAP and non-SAP) as OData services. HTTP, HTTPS protocols and XML, JSON response formats are supported.

OData Feature Status
Simple query (feed) Supported
System query options: $select and $filter
Note $filter is supported only via custom processor.
EDM type Supported
Complex types Supported
  • Multiple ChangeSets are supported in a $batch request however, only one operation (POST, PUT or DELETE) is supported per ChangeSet. One or more entities can be modified by these ChangeSets.
  • The $batch request is ignored when the batch request boundary is preceded by one or more spaces.
Partially supported
Read Supported
Create Not supported
Update Not supported
Delete Not supported
System query options: $format, $orderby, $skip, $top, $inlinecount Not supported
Delta token Not supported
Association/navigation Not supported
$count Not supported
Deep insert Not supported
Custom query options Not supported
Function imports Not supported
$link Not supported
$value Not supported


  1. Use API toolkit for SAP Mobile Platform to register the service:

    For details of the tasks performed in this step, see API toolkit for SAP Mobile Platform Documentation on https://help.hana.ondemand.comInformation published on SAP site. The relevant topic to refer to is provided in the corresponding sub steps below.

    1. Create an OData implementation project. See Creating an OData Implementation Project.
    2. Select the Rest Service to bind with an entity set. See Selecting a Data Source.
    3. Use the Custom Processor plug-in to write a mapping script from REST to OData format. See Custom Processor.
    4. You can generate integration content or generate and deploy it. See Generating and Deploying Service Implementation Project.
  2. Log in to Gateway Management Cockpit. If you chose,
    1. Generate Integration Content while registering the service in API Toolkit for SAP Mobile Platform, deploy the content bundle. See Deploying a Custom Service from Gateway Management Cockpit for more information.
    2. Generate and Deploy Integration Content while registering the service in API Toolkit for SAP Mobile Platform, you should see the registered service in the Registered Services screen.
  3. Assign an existing destination to the service or entity sets. See Assigning and Removing OData Service Destinations. Otherwise, create a new destination and then assign it. See Creating Destination on Gateway Management Cockpit.