Skip to Content
Technical Articles

OData API in SAP Cloud Integration for Beginners

This blog post covers how to expose an OData API in SAP Cloud Integration with CRUDQ operations.


In SAP Cloud Integration, You can develop OData API that exposes existing data sources, such as SOAP, OData, ODC, and REST as OData endpoints. In this blog post, I will be exposing an existing OData Service with some modifications in SAP Cloud Integration.
Official Documentation


  1. You have to know OData protocol and how to use an OData Service for Create, Read, Update, Delete operations. Help
  2. You have to know how to model Integration Flows and know how to use Message mappings.
  3. You have to know the difference between OData Service project and Integration Flow with OData sender.
  4. How to use Postman Rest client to perform HTTP calls.

What this blog doesn’t cover

  1. How to create the request payload for Create, update and $batch operations.

Help with Olingo

SAP Cloud Integration uses Olingo library to serialize/deserialize the request-response and URI.

  1. Olingo UriInfo stores the request URI information.
  2. This git contains java code to getUriInfo object with olingo library.

OData Receiver Service

OData Service that I will be using is the reference service from

TIP: In the above service URL, (ODataSenderCPIDemo) represents a unique session for the manipulation of records. i.e., Entities created, updated, deleted will reflect only in that session. You can have your own session with any string within S() for your testing.

X-CSRF-Token support

OData API exposed is CSRF enabled. SAP Cloud Integration expects its clients to send a valid CSRF token in the HTTP header X-CSRF-Token with every request, except for GET
If you don’t, you will receive an error response with the status code 403

  1. Fetch a CSRF-token
    Send a GET-request to your service root with the appropriate Authorization header and the X-CSRF-Token header with value Fetch.
  2. Send the CSRF-Token with every request
    Now, you can send your payload-requests with the header  X-CSRF-Token set to the value received in the response header of step 1. If your session or token expires, you will get a 403-error again. Just repeat the steps above.

OData Sender Behavior

  1. OData sender converts the incoming OData Request payload (atom+xml / json) to simple XML.
  2. For OData Operations which has response body (create, read), the final step in the IFlow has to be a simple XML which represents the Entities defined in OData sender Edmx.
  3. The URI of the OData Sender can have OData query parametersa and other custom parameters. The URI parameters have to be retrieved using Olingo UriInfo which is available in message header “UriInfo”.

OData Sender Updates

  1. OData sender version 1.2 onwards: Request URI, QueryString and HTTP Method are stored in exchange header CamelHttpUri, CamelHttpQuery, and CamelHttpMethod respectively. In order to get these headers, it has to be added in ‘Allowed Headers’ in integration flow Runtime configuration as below.
  2. The exception message will not be returned to the client. Refer KBA


  1. Create an OData Sender Artifact
  2. Deploying an OData Service
  3. Invoking an OData Service
  4. Editing an OData Model
  5. Read
    5.1 Read with Navigation
  6. Query
    6.1 $expand
  7. Create
    7.1 Deep Insert
  8. Update
  9. Delete
  10. FunctionImport
  11. Set Custom Error Code and Response Body for Error


1. Create an OData API Artifact

  1. Create an OData Sender project by following the documentation up to step 7.

  2. Download the metadata from existing OData service from postman$metadata
    TIP: Use your own session
  3. Open the created artifact in Edit mode, choose Import Model Wizard
  4. Select Data Source Type as ODATA, Browse the Edmx file saved in step 2
  5. Choose the entities that you want to expose in the API from SAP Cloud Integration. I have chosen Products and Suppliers (without Address fieds)
  6. Choose the fields that will be key in each entity. I have chosen ID and ReleaseDate to be the Key of Products.
  7. Click Finish.
  8. Now the OData Service is ready with no operations configured. In order to deploy an OData API, at least one operation has to be configured. Click on bind link under Actions.
  9. Choose the Entity and the End Point to your OData Receiver Service.
  10. An Iflow template for OData Read operation will be generated. Now the OData Service is ready for Deploy.

2. Deploying an OData API

  1. Deploy the service by following the documentation.
  2. On the Endpoints tab, you can view the endpoint URI. This endpoint URI is the OData Service Root URI.

3. Invoking an OData API

  1. Copy the endpoint URI by choosing the copy icon.
  2. From Postman,  fire the request for the endpoint with the user having the role ESBMessaging.send
  3. The OData API has 2 entities ProductSet and SupplierSet. Copy the EDMX URL and trigger it from Postman.
    The OData Receiver Service had Products and Suppliers, which is exposed in SAP Cloud Integration as ProductSet and SupplierSet. Similarly, you can see that the ProductSet has 2 Key property that was configured previously.

4. Editing an OData Model

  1. Follow the steps from the documentation.
  2. Rename the ID of ProductSet to ProductID and ID of SupplierSet to SupplierID.
  3. Save and deploy. $metadata call will reflect the changes.

The following operations are supported when developing an OData service in the SAP Cloud Integration. Let’s configure and test each operation one by one.

5. Read

  1. Configure the Read operation for ProductSet. In Configure OData Data Source, make sure to give the same endpoint for all operations (with the same session)
  2. Navigate to IFlow Editor.
  3. A predefined IFlow will be created. The script step of the IFlow will have the template to add $top and $skip to add to message header “odataURI”.
  4. Modify the groovy script to set the key parameter as message header with key “Key_<propertyName>”
    The URI parameters has to be retrieved using Olingo UriInfo which is available in message header “UriInfo”.

    This git contains java code to get UriInfo object. Since you cannot debug a script, you can use the java class to understand the UriInfo and derive the key property values from request URI.

    import java.util.HashMap;
    import org.apache.olingo.odata2.api.uri.UriInfo;
    def Message processData(Message message) {
    	def uriInfo = message.getHeaders().get("UriInfo");
        	def keyPredList = uriInfo.getKeyPredicates();				
    		def k=0;
    		for(item in keyPredList)
    	return message;
  5. The Receiver OData is configured to get the key value from the header set from the script.
  6. The Response from OData receiver has to be mapped as per the entities in sender Edmx.
  7. Perform the Read request from postman https://<serviceRoot>/ProductSet(ProductID=1,ReleaseDate=datetime’1995-10-01T00:00:00′)

5.1 Read with Navigation

  1. Edit the OData Model such that ProductsSet has navigation to SupplierSet and vice versa.
        xmlns:sap="" Version="1.0">
            xmlns:m="" m:DataServiceVersion="2.0">
                xmlns="" Namespace="S1">
                <EntityContainer Name="EC1" m:IsDefaultEntityContainer="true">
                    <AssociationSet Name="Products_Supplier_Suppliers" Association="S1.Product_Supplier_Supplier_Products">
                        <End Role="Product_Supplier" EntitySet="ProductSet"/>
                        <End Role="Supplier_Products" EntitySet="SupplierSet"/>
                <EntityType Name="Product">
                    <NavigationProperty Name="Supplier" Relationship="S1.Product_Supplier_Supplier_Products" FromRole="Product_Supplier" ToRole="Supplier_Products"/>
                <EntityType Name="Supplier">
                    <NavigationProperty Name="Products" Relationship="S1.Product_Supplier_Supplier_Products" FromRole="Supplier_Products" ToRole="Product_Supplier"/>
                <Association Name="Product_Supplier_Supplier_Products">
                    <End Role="Product_Supplier" Type="S1.Product" Multiplicity="*"/>
                    <End Role="Supplier_Products" Type="S1.Supplier" Multiplicity="0..1"/>
  2. The navigation ProductsSet to Supplier is of cardinality * to 1. Hence the request ProductSet(ProductID=1,ReleaseDate=datetime’1995-10-01T00:00:00′)/Supplier will trigger the Read operation of SupplierSet. Configure Read for SupplierSet with the initial script containing the below code.
    import java.util.HashMap;
    import org.apache.olingo.odata2.api.uri.UriInfo;
    def Message processData(Message message) {
    	def uriInfo = message.getHeaders().get("UriInfo");        
    	def keyPredList = uriInfo.getKeyPredicates();				
    		def k=0;
    		for(item in keyPredList)
    			log.logErrors(LogMessage.TechnicalError, (++k) + " Key Predicate value for property "+item.getProperty().getName()+" is: "+ item.getLiteral());
    	def targetEntityName = uriInfo.getTargetEntitySet().getName();
    	def startEntityName = uriInfo.getStartEntitySet().getName();	
    	//Handle Navigation request
    	    log.logErrors(LogMessage.TechnicalError, "Navigation request from source "+ startEntityName + " to target " +targetEntityName);
    	    //Do your own processing to decide which Supplier ID to retrive.
                //Handle SupplierSet Read
    	return message;

    TIP : In the script above, log.logErrors are used to print the values of my variable in logs. These logs appear in System Log file of type CP default trace as below.
    …..[Gateway][TECHNICAL][TechnicalError]:Entity Name::CategorySet|

  3. Do the required response mapping. The navigation query from postman https://<serviceRoot>/ProductSet(ProductID=1,ReleaseDate=datetime’1995-10-01T00:00:00′)/Supplier will return Supplier of ID 0.

6. Query

  1. Add the initial script step to hold the query options Filter, top, skip, orderby, expand as below. Query options are retrieved using Olingo UriInfo which is available in message header “UriInfo”.
    Refer point 1 in OData Sender Updates to get the query option.
    $select, $count doesn’t need to be handled in the script. This git contains java code to get UriInfo object. Since you cannot debug a script, you can use the java class to understand the UriInfo and derive each of the OData query options like $top $filter.
  2. import;
    import java.util.HashMap;
    import org.apache.olingo.odata2.api.uri.UriInfo;
    def Message processData(Message message) {
    	def uriInfo = message.getHeaders().get("UriInfo");
    	def odataURI = new StringBuilder();
    	def urlDelimiter = "&";
    	def urlConcat = "?";
    	def entityName = uriInfo.getTargetEntitySet().getName();
    	log.logErrors(LogMessage.TechnicalError, "Entity Name::"+entityName);
    	if (uriInfo.getTop() != null){
    		def top = uriInfo.getTop();
    		log.logErrors(LogMessage.TechnicalError, "Top value:"+top);
    	if (uriInfo.getSkip() != null){
    		def skip = uriInfo.getSkip();
    		log.logErrors(LogMessage.TechnicalError, "Skip value:"+skip);
    	if(uriInfo.getFilter() != null){
    	    def filterValue = uriInfo.getFilter().getUriLiteral();
    	    filterValue = filterValue.replace("ProductID","ID");  //The receiver has property names as ID and not ProductID
    	    log.logErrors(LogMessage.TechnicalError, "Filter value: "+filterValue);
    	if(uriInfo.getOrderBy() != null){
    	    def orderBy = uriInfo.getOrderBy().getExpressionString();
    	    log.logErrors(LogMessage.TechnicalError, "orderby value: "+orderBy);
    	if(uriInfo.getExpand() != null){
    	    def expandList = uriInfo.getExpand();
    	    def expandValue;
    	    log.logErrors(LogMessage.TechnicalError, "expandList size: "+expandList.size());
        		for(item in expandList){
        		    if(item.size() > 0){
        		        for(navSegments in item){
        			            expandValue = navSegments.getNavigationProperty().getName();  //TO DO : Multiple expand values to be handled
    	        log.logErrors(LogMessage.TechnicalError, "expand value: "+expandValue);
    	log.logErrors(LogMessage.TechnicalError, "URI value:"+ odataURI.toString());
    	return message;
  3. The receiver OData has to be configured to get the system query option from the header ${header.odataURI}
  4. Map the response from receiver to Sender Edmx. For $expand scenario the expanded entity has to be mapped. The Response mapping template will generate source and target with only root entity.
    I have created the XSD for source and target containing the Supplier child and used that XSd for the mapping.
    TIP: You can use the OData receiver query modeler to generate the XSD. For the XSD to have Entity and its navigation, choose ‘Create’ with sub levels.
  5. From Postman, perform Query with various query options like $select, $top, $skip, $filter, $expand.
  6. To enable serverside pagination with next link in response, set the message header ‘skipToken’ with the number of records that have been returned. Eg, skipToken : 20 will add the next Link in response as <link href=”Products?$skiptoken=20″ rel=”next”/>

7. Create

The Response of Create should have a response body of the created entity with the key properties.

  1. Configure create for ProductSet.
  2. Request from the Sender has to be mapped to the Receiver edmx.
  3. Response from the receiver has to be mapped to Sender Edmx.
  4. Perform Create operation from postman

7.1 Deep Insert

The Response of Deep Insert should have a response body with only the root Entity and not the navigation entities.
UPDATE: Software increment 2101 allows deepinsert response body to have navigaton entities too. You have to map the response structure with the root entity and the navigation entity.

  1. In case of deep insert, the sender generates the nested structure of the deep insert payload and the same has to be handled in the iflow as per the use case.
  2. The request mapping with nested Supplier has to be done.
    Refer this blog for detailed steps to get the XSD.
  3. The response of the deep insert should have only the root entity for the OData sender. Please note in below response mapping, only the root Entity ProductSet is mapped.
  4. The OData deepinsert request will be converted to XML by OData sender whcih has to be handled as per your business logic.
    I have enabled trace and triggered deepinsert and the equivalent XML is as below.
  5. Since the OData receiver is capable of handling the deep insert, I have just mapped the incoming payload to the receiver as shown in step 2.
  6. DeepInsert triggered from the postman.
  7. I verify that the Supplier with SupplierID 6543 is created by querying on the OData receiver URL configured.

8. Update

  1. URI handling: Similar to Read operation, The ID has to be correctly passed to the receiver.
  2. Payload: The request payload has to be mapped just like Create.

9. Delete

  1. URI handling: similar to Read operation, The ID has to be correctly passed to the receiver.
  2. The is no need for request and response mapping.

10. FunctionImport

  1. Edit the Iflow model to have a FunctionImport defined. I have defined GetProductsGTRating which will fetch all the Products greater than the rating given in input.
  2. Configure the FunctionImport.
  3. Modify the initial script step to store the function import parameters into the message header.
    import java.util.HashMap;
    import org.apache.olingo.odata2.api.uri.UriInfo;
    def Message processData(Message message) {
    	def uriInfo = message.getHeaders().get("UriInfo");	
    	def funcImpParams = uriInfo.getFunctionImportParameters();
    	if(funcImpParams  != null && !funcImpParams.isEmpty()){
    	    log.logErrors(LogMessage.TechnicalError, "FunctionImport"+funcImpParams);
    	    def k=0;
    		for(item in funcImpParams)
    			log.logErrors(LogMessage.TechnicalError, "Functionimport Param "+(++k)+" : "+ item.getKey()+" = "+item.getValue().getLiteral());
    	return message;
  4. Model the Iflow to handle the defined function Import. The OData receiver is configured to get all the Products with rating greater than the header value ‘rating’.
  5. Do the required response mapping.
  6. Trigger the functionimport from the postman, <service root>/GetProductsGTRating?rating=2.
    The response will contain all the Products with rating greater than 2.


11. Set Custom Error Code and Response Body for Error

  1. The exception message will not be returned to the client. Refer point 2 in OData Sender Updates .
  2. Perform a Create operation on ProductSet without the Key Property in payload as below.
    	"ReleaseDate": "/Date(694224000123)/",
    	"Rating": 4,
    	"Price": "2.5"


  3. Below is the response that will be seen.500 status code with default error.
  4. This response can be customized with custom response code and response message.
  5. Add an exception subprocess in create Iflow. Add a content modifier.
  6. Set the message header “CamelHttpResponseCode” to the status code you want to propagate to Sender.
  7. Save and deploy the artifact and trigger the create operation again. The status code will be 400 instead of 500.
  8. The Iflows resources has an XSD named Error. Set the message body with the error message as per the XSD.
  9. Trigger the create without key property. The response will be custom status code and message set in exception subprocess.


OData Sender related blogs

  1. Introduction to Creating OData Service in HANA Cloud Integration
  2. OData Service Project vs Integration Project when to use what in Cloud Platform Integration
  3. OData Service in $batch Mode
You must be Logged on to comment or reply to a post.
  • Hi Saranya, Very helpful article indeed.

    I was trying to do the same with Success Factors odata api. However while importing EDMX , it is giving errors.

    "Element 'tagcollection' is not valid at this position Namespace of attribute 'label' not found Namespace of attribute 'creatable' not found Namespace of attribute 'updatable' not found Namespace of attribute 'sortable' not found Namespace of attribute 'filterable' not found Namespace of attribute 'visible' not found"

    Can you please guide how to download edmx in case of SF APIs or if any modification is needed.


    • Hi Ashuthosh,
      SF OData Edmx is annotated with sap namespace for properties as below which is not understood by the OData Sender GUI.
      <Property Name="addressLine1" Type="Edm.String" Nullable="true" sap:required="false" sap:creatable="true" sap:updatable="true" sap:upsertable="true" sap:visible="true" sap:sortable="false" sap:filterable="false" MaxLength="255" sap:field-control="userPermissionsNav/addressLine1" sap:label="Address Line 1"/>

      However, instead of importing the EDMX, you could go to the Edmx Editor and paste the complete EDMX. This will show the lines with error and you could fix them one by one. I have copied the EDMX of user Entity from SF, and I have commented the line 17 to 20 to fix the validation errors.

  • Hi Saranya,

    Great piece of work.

    Can you comment if we can integrate SAP Gateway oData services(v2) in Cloud platform iFlow ? Also is it possible to reuse the same session from the cloud platform for all the oData api calls to the SAP backend ?

    Note: oData services in the backend are stateful.i.e., soft state enabled.



  • Hi Saranya,

    Thanks for the blog. For deeply nested structures on the request side (For Ex: Supplier inside Products), do we have always have to create the xsd manually? Although the edmx file has NavigationProperty specified correctly, there is no option during step 2 "Select Structure" to select the nested structure. It only displays fields of individual "Entity Types" separately without displaying the fields of the referenced Entity Type(s). Please clarify.



    • Hi Malgi,

      OData Sender adapter doesn't support XSD generation. Hence you have to manually create one.
      Whereas the OData receiver supports the XSD generation for deep structure.



  • Hi Saranya,


    I am stuck in step 5.6

    I am never able to save the mapping. I access the generated mapping and it has both entities without any mapping I then add mapping to all fields and then save and it says mapping saved.

    Then when I try to access it again the mapping is gone.

    I tried creating a new mapping but once I do it and finish the mapping it gives an error that the mapping file that I just created is not available.

    Not sure what I am doing wrong.


    Thank you in advance



  • Hello Saranya,

    Thanks for the helpful documentation.

    But I am having a hard time while implementing 5.READ operation. I believe I am doing something wrong in receiver configuration.


    I've added this as a query option;


    My URL looks like this ;


    And getting error like this;

    <?xml version='1.0' encoding='UTF-8'?>
    <error xmlns="">
        <message xml:lang="en">Unknown literal: '[SAP_CRM_BUPA]'.</message>


    Help is very much appreciated.



  • Thank you for your documentation.

    Can I ask you some questions?  Can I custom response body and response header for successful creation(post method)?(same as error response which you mentioned as above. (11. Set Custom Error Code and Response Body for Error) 

    • Hi Sawanee,

      As of now, setting a custom response for a successful operation is not possible. OData spec has a defined status codes and response body structure for each OData operation. And our library sets them. It cannot be customized.

      • I suspect that when I upsert odata at successfactor, I will get response like this

        <?xml version=”1.0″ encoding=”utf-8″?>

        <feed xmlns=”” xmlns:m=”” xmlns:d=””>
                <content type=”application/xml”>
                        <d:message m:null=”true”></d:message>
                        <d:index m:type=”Edm.Int32″>0</d:index>
                        <d:httpCode m:type=”Edm.Int32″>204</d:httpCode>
                        <d:inlineResults m:type=”Bag(SFOData.UpsertResult)”></d:inlineResults>

        when I call post method to custom odata service in CPI

        I will get response from custom odata service in CPI (not same response from successfactor)
        Can I custom EDMX file for getting like successfactor response? Should I create function import in EDMX? because I can set returnType in response
        but I want to use "Operation Details: CREATE" not function import
        • Hi Sawanee Aimsaard,
          Your requirement is to perform CREATE call on an entity and get the response with entirely different entity. This is not possible. That is why SuccessFactors has designed the OData API with FunctionImport and set the returnType as "UpsertResult".
          You will have to follow the same, however as per specification: FunctionImport cannot have a request body. This is not adhered to by SuccessFactors upsert.
          So to answer your question, you cannot customize success response with the properties of a different entity. As a hack, you can have the same set of properties (editstatus, httpCode, index etc) in the Entity on which CREATE is performed.
  • hi Mam,

    Blog is very useful


    We are struct from one month can you please help me how to configure data source entity type .

    Our C4C is not able to provide which entity we need to select currently we have 11 iflow .


    Here how you select can I identify from my c4c which entity I need to select

    Please do the need ful



    • Hi Sree Harsha,
      Your question is confusing. As an OData service developer, you have to decide which entity do you want to expose via CPI. You have to select that appropriate entity from your C4C. This is as per your business use case.

  • Hi Saranya,

    We couldn't implemented the query option $count in CPI. What we are trying to do is we need to get all the marketing contacts count from marketing system. But unable to add the query parameter into request URL. Have you ever done this before? If so, can you help?

    • Hi Mert,
      $count doesn't need any implementation. As far as Query is configured, $count will work. The /$count parameter should appear immedietly after the EntitySet name in the URI.

      For Example:
      gw/odata/SAP/ODATASAMPLE;v=1/ProductSet/$count?$filter=ProductID gt 6
      gw/odata/SAP/ODATASAMPLE;v=1/ProductSet/$count?$filter=ProductID gt 6&$top=1



      • Hi Saranya,


        Yes it is working fine when I give a $top parameter. But without $top parameter, it does not give me the total number. But when I work directly with the endpoint it does give me a proper response.


        /gw/odata/SAP/ODATASAMPLE;v=1/ProductSet/$count   >> this does not work

          • Hi,
            400 Bad Request must be returned from the OData receiver adapter. Please check the trace thoroughly and analyze the response from OData receiver.


          • Hello Saranya,

            Thank you so much for this blog.

            We are getting 400 Bad request error in CREATE operation when we are sending a field in request payload which has property creatable="false".

            The error can be elaborately seen as a attachment ODataV2_Adapter_Response_Body when we enable the traces.

            But this error needs to be sent back to the requesting client. Could you please guide how should we achieve that.




  • Hi Saranya,

    Few questions from my end. Please help answer the same

    1. In case of Sender OData adapter is the response in XML? Doesn't the OData adapter convert the response to JSON? How do we send JSON response back to sender?
    2. Can we not have multiple response nodes? For Ex: For a particular message(OrderID), there can be multiple responses from ECC and all the responses needs to be sent back

    For Ex:

    <responseMsg>Message 1</responseMsg>
    <responseMsg>Message 2 </responseMsg>


    Currently we receive java.util.ArrayList cannot be cast to java.util.HashMap error while processing multiple responses.




    • Hi Malgi,
      Answers for your question.

      1. The response is atom/xml by default. If you expect json response you have to add the HTTP header Accept:application/json to the request.
      2. you can achieve this by $expand. 
  • Hello Saranya,


    How can we disable X-CSRF protection for Odata sender as there is no checkbox to enable/disable CSRF in Odata sender adapter?




  • Hi Saranya,

    Do you have an example or have suggestions to convert standard REST service to a OData service? SAC can integrate only with OData but I have a service that has REST endpoints. Want to integrate SAC with this REST service and was thinking of a OData wrapper if possible.




  • Hi Saranya,


    First of all, this is such a great blog post. Thanks for putting everything together.

    I have a question on query filter. What is the correct way to use query filter. I am getting invalid query filter error on postman. Any idea?



  • Hi Saranya,


    I am trying to send CREATE request while testing the API but it is resulting in 403 forbidden error whereas when I am sending READ request, it works totally fine.

    I took the trace in both cases but for CREATE request, it does not reach CPI

    Could you please help me out on this.




  • Hello dears. I am sending the following character string in the URI tag to MKT, but when I send the material with the space it gives me an error, is there another way to send it with a space in the material? in mkt it must be replicated with space



  • Hi Saranya,


    great blog.  I call my oData service


    I read the filter value with

    def uriInfo = message.getHeaders().get("UriInfo");

    if(uriInfo.getFilter() != null){myLogic...}

    But now uriInfo.getFilter() is always null. I read about some update on OData Service in CPI.

    Do you have any idea about this problem?





    • Hi Massimiliano,

      Ideally uriInfo.getFilter()  should return the filter parameter. Can you verify the filter contains valid filter expression? Also, try with another filter expression. There is no reason for this to return null as long as the expression is valid.

  • Hi Saranya,

    Thank you for your documentation. Very useful. Only, i have a question of your documentation, please:

    I am currently implementing the deep entity scenario. First, I edit the metadata.edmx (Result of the import of OData example metadata) to meet associations.

    I did all the steps indicated in the point of Deep Entity (Create Operation/Create Receiver dummy/Mapping the Channel in dummy and real receiver). However in the request mapping, on the left side I associate it with the xsd file generated with the OData Dummy (Sender edmx) and on the right side I associate with the xml metadata from

    But, on the left side, you can see the associations without problems. On the other side, the associations as such are still not visualized.

    What would I be missing? It should be noted that placing the xsd of the Receiver Channel (Also edit it according to what you commented in the guide) instead of the metadata of the ODataDemo if the fields are shown, but it generates an error when executing the service

    I hope you can help me please. Thank you very much in advance for your answer.



  • Hi Saranya,
    We are also facing issue with deep structure, We have done the config for both parent and associated entity set.
    In the response mapping, We have received both entity sets in the left  side, but we get only the Parent object in the right side and the associated entity is missing.
    Because of this, we are not getting the expected result with all required fields in the response.
    We are getting only the response fields of the parent entity and the fields from associated entity sets are missing in the response.
    Please let us know If we need to do any additional configuration to get the associated entity sets in the right side of the response mapping.
  • Hello Saranya Baskaran ,


    First of all,congratulations for the blog. This is really so very helpful being quite elaborate too.

    Now here I am facing some issue in $expand function in the query.

    We are dealing with multiple entities and a deep structure on which we have to create a query. So I have used the exact script as you have mentioned and while for me expand operation is working for a single entity but where we have to call multiple entities, it isnt.

    Example queries not working:

    1.;v=1/RegisteredProductCollection?$filter=ID eq '2424'&$expand=RegisteredProductPartyInformation,RegisteredProductDescription

    The error in POSTMAN tool that  it is giving is:


    while trying to invoke the method org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties.getExpandSelectTree() of a null object loaded from local variable 'inlineProperties'



    And when I enable traces:

    As you can see, the odataURI created takes only 1 last entity from the CamelHTTPQuery.

    Also, though its not giving any responce in POSTMAN , it shows as successful status in Message Monitoring of CPI.

    And seems to be successfully returning the response as per odataURI but even this incomplete response never reaches back to POSTMAN.



    2.;v=1/RegisteredProductCollection?$filter=ID eq '2424'&$expand=RegisteredProductDescription,RegisteredProductPartyInformation/RegisteredProductOtherPartyContactParties

    3.;v=1/RegisteredProductCollection?$filter=ID eq '2424'&$expand=RegisteredProductPartyInformation/RegisteredProductOtherPartyContactParties

    Even in this case odataURI remains the same as above and the message failed unable to find the requested entity: RegisteredProductOtherPartyContactParties


    "Could not find property with name: 'RegisteredProductOtherPartyContactParties'."


    Could you please help here. Seems the expand list is taking last in only.


    Thanks in advance.



  • Hi Saranya,
    Thanks for the detail instructions.  I’m following your instructions but getting an error when I try to implement 5.2 (Read with Navigation).  After updating the Edmx and Groovy script, I tried calling the service with the /ProductSet(ProductID=1,ReleaseDate=datetime’1995-10-01T00:00:00′)/Supplier at the end, but I’m getting an error of “Could not find property with name: ‘Supplier’.
    I checked the Edmx and Groovy script, and it looks correct.  Can you tell me why I’m getting this error, and couldn’t navigate to “Supplier”?
    Update: Never mind, I made a typo in the NavigationProperty tag.  It working now.
  • Hi Saranya,

    Very well articulated blog.

    I was able to develop the oData service to consume oData web service. When I did the same to consume SOAP web service, it is giving the error “Requested entity could not be found”. I have also posted as a question in the forum. Can you please check and let me know where I am wrong?




    UPDATE: I forgot to add the SET at the end of the url. Also, configured the READ operation. Then it worked.

  • Hi Saranya,

    Thank you for the detailed blog which has been very useful for us.

    We are using Sybase ASE Database. SAP UI5 Portal required OData queries to be executed and hence same was implemented with the help of groovy as per this blog.

    However, we found that OData Services are supported in Sybase On Premise and OData queries can be executed directly in OnPremise Sybase ASE as per below blogs.

    We wanted to check if Sybase ASE Cloud Database can also support the same, we had raised incident but didn't find the answer. Please let us know if you have any idea on the same.

    Thanks and Regards,

  • Hi Saranya ,

    Is it possible to use in the same scenario an OData that comes from ECC System ?


    The big picture is to receive some information saved in a custom table in ECC System to the mapping process inside the iFlow .


    Best regards


  • Hi ,

    How to handle this in message mapping ?

    "The Response of Deep Insert should have a response body with only the root Entity and not the navigation entities"




  • Hi all & Saranya Baskaran ,

    I've got a problem with the $count parameter. The iFlow runs for several minutes since it caches all the values of the EntitySet and does the "count" only after getting all the entries and thus having a massive payload. Is this working as designed or might I have a configuration error within my iFlow? I've got the header ${header.odataURI} in the query options. The odataURI ist not filled with the $count parameter.

    The blog states "$select, $count doesn’t need to be handled in the script." but does it mean that it needs to catch all entries of an odata entity and send them to CPI before counting?