10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

SAP Community  Products and Technology  Technology  Technology Blogs by SAP

 OData API in SAP Cloud Integration for Beginners

Technology Blogs by SAP

Learn how to extend and personalize SAP applications. Follow the SAP technology blog for insights into SAP BTP,
ABAP, SAP Analytics Cloud, SAP HANA, and more.

Blog  What are you looking for today?

OData API in SAP Cloud Integration for Beginners

saranya_baskaran2
Advisor

‎2019 Aug 12 12:49 PM

 67 Kudos  127,049

SAP Managed Tags: SAP Integration Suite, Cloud Integration

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

Introduction
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

Prerequisite

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 1/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

https://www.odata.org/odata-services/

https://services.odata.org/V2/(S(ODataSenderCPIDemo))/OData/OData.svc/

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 2/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 3/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

Contents

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

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 4/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

https://services.odata.org/V2/(S(ODataSenderCPIDemo))/OData/OData.svc/$metad
ata
TIP: Use your own session

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 5/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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)

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 6/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 7/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 8/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 9/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 10/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 11/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

1 import com.sap.gateway.ip.core.customdev.util.Message;
2 import java.util.HashMap;
3 import org.apache.olingo.odata2.api.uri.UriInfo;
4 import com.sap.gateway.ip.core.customdev.logging.*;
5 def Message processData(Message message) {
6 def uriInfo = message.getHeaders().get("UriInfo");
7 def keyPredList = uriInfo.getKeyPredicates();
8 def k=0;
9 for(item in keyPredList)
10 {
11
message.setHeader("Key_"+item.getProperty().getName(),item.g
12 }
13 return message;
14 }​

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 12/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 13/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

<edmx:Edmx

xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx"
xmlns:sap="http://www.sap.com/Protocols/SAPData"
Version="1.0">
<edmx:DataServices

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservic
m:DataServiceVersion="2.0">
<Schema

xmlns="http://schemas.microsoft.com/ado/2008/09/edm"
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"/>
</AssociationSet>
</EntityContainer>
<EntityType Name="Product">
.....
<NavigationProperty Name="Supplier"
Relationship="S1.Product_Supplier_Supplier_Products"
FromRole="Product_Supplier" ToRole="Supplier_Products"/>
</EntityType>
<EntityType Name="Supplier">
.....
<NavigationProperty Name="Products"
Relationship="S1.Product_Supplier_Supplier_Products"
FromRole="Supplier_Products" ToRole="Product_Supplier"/>
</EntityType>
<Association
Name="Product_Supplier_Supplier_Products">
<End Role="Product_Supplier"
https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 14/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

28 Type="S1.Product" Multiplicity="*"/>
29 <End Role="Supplier_Products"
Type="S1.Supplier" Multiplicity="0..1"/>
</Association>
</Schema>
</edmx:DataServices>
</edmx:Edmx>​

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 15/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

1 import com.sap.gateway.ip.core.customdev.util.Message;
2 import java.util.HashMap;
3 import org.apache.olingo.odata2.api.uri.UriInfo;
4 import com.sap.gateway.ip.core.customdev.logging.*;
5 def Message processData(Message message) {
6 def uriInfo = message.getHeaders().get("UriInfo");
7 def keyPredList = uriInfo.getKeyPredicates();
8 def k=0;
9 for(item in keyPredList)
10 {
11 log.logErrors(LogMessage.TechnicalError,
(++k) + " Key Predicate value for property
"+item.getProperty().getName()+" is: "+
12 item.getLiteral());

13 message.setHeader("Key_"+item.getProperty().getName(),item.g
14 }
15 def targetEntityName =
16 uriInfo.getTargetEntitySet().getName();
17 def startEntityName =
18 uriInfo.getStartEntitySet().getName();
//Handle Navigation request
19 if(!targetEntityName.equals(startEntityName)){
20 log.logErrors(LogMessage.TechnicalError,
21 "Navigation request from source "+ startEntityName + " to
22 target " +targetEntityName);
23 //Do your own processing to decide which Supplier
24 ID to retrive.
25 message.setHeader("SupplierID","0");
}else{
//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|
https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 16/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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".
[OR]
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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 17/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

import com.sap.gateway.ip.core.customdev.util.Message;
import java.util.HashMap;
import org.apache.olingo.odata2.api.uri.UriInfo;
import com.sap.gateway.ip.core.customdev.logging.*;
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();
if(odataURI.size()!=0)
odataURI.append(urlDelimiter);
odataURI.append("\$top=").append(top);
log.logErrors(LogMessage.TechnicalError, "Top
value:"+top);
}
if (uriInfo.getSkip() != null){
def skip = uriInfo.getSkip();
if(odataURI.size()!=0)
odataURI.append(urlDelimiter);
odataURI.append("\$skip=").append(skip);
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
if(odataURI.size()!=0)
odataURI.append(urlDelimiter);
odataURI.append("\$filter=").append(filterValue);
log.logErrors(LogMessage.TechnicalError, "Filter
value: "+filterValue);
https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 18/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

38 }
39 if(uriInfo.getOrderBy() != null){
def orderBy =
40 uriInfo.getOrderBy().getExpressionString();
41 if(odataURI.size()!=0)
42 odataURI.append(urlDelimiter);
43 odataURI.append("\$orderby=").append(orderBy);
44 log.logErrors(LogMessage.TechnicalError, "orderby
value: "+orderBy);
45 }
46 if(uriInfo.getExpand() != null){
47 def expandList = uriInfo.getExpand();
48 def expandValue;
49 log.logErrors(LogMessage.TechnicalError,
50 "expandList size: "+expandList.size());
if(expandList.size()!=0){
odataURI.append(urlDelimiter);
51 for(item in expandList){
52 if(item.size() > 0){
53 for(navSegments in item){
54 expandValue =
55 navSegments.getNavigationProperty().getName(); //TO DO :
Multiple expand values to be handled
56 }
57 }
58 }

59 odataURI.append("\$expand=").append(expandValue);
60 log.logErrors(LogMessage.TechnicalError,
61 "expand value: "+expandValue);
62 }
}
log.logErrors(LogMessage.TechnicalError, "URI
value:"+ odataURI.toString());
message.setHeader("odataEntity",entityName);
message.setHeader("odataURI",odataURI.toString());
return message;
}

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 19/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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. $inlinecount=allpages will return the count in response only if the message

property InlineCount is set with an Integer value.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 20/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 21/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 22/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 23/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.
https://services.odata.org/V2/(S(ODataSenderCPIDemo))/OData/OData.svc/Supplier
s(6543)

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 24/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.
https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 25/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

1 import com.sap.gateway.ip.core.customdev.util.Message;
2 import java.util.HashMap;
3 import org.apache.olingo.odata2.api.uri.UriInfo;
4 import com.sap.gateway.ip.core.customdev.logging.*;
5 def Message processData(Message message) {
6 def uriInfo = message.getHeaders().get("UriInfo");
7 def funcImpParams =
8 uriInfo.getFunctionImportParameters();
9 if(funcImpParams != null &&
!funcImpParams.isEmpty()){
10 log.logErrors(LogMessage.TechnicalError,
11 "FunctionImport"+funcImpParams);
12 def k=0;
13 for(item in funcImpParams)
{
14 log.logErrors(LogMessage.TechnicalError,
"Functionimport Param "+(++k)+" : "+ item.getKey()+" =
15 "+item.getValue().getLiteral());
16
17 message.setHeader(item.getKey(),item.getValue().getLiteral()
18 }
}
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'.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 26/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

1 {
2 "ReleaseDate": "/Date(694224000123)/",
3 "Rating": 4,
4 "Price": "2.5"
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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 27/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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.

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 28/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

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

4. https://blogs.sap.com/2016/06/10/deep-insert-suport-in-odata-provisioning-in-hci/

5. https://blogs.sap.com/2017/06/05/cloud-integration-how-to-setup-secure-http-
inbound-connection-with-...

6. https://blogs.sap.com/2017/07/17/odata-service-project-vs-integration-project-
when-to-use-what-in-cl...

7. https://blogs.sap.com/2018/09/16/sap-cloud-platform-integration-odata-v2-
conditional-update/

Labels:

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 29/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

Technology Updates

Tags:

kb odata provisioning OData Sender OData Sender in CPI SAP Cloud integration

SAP Cloud Platform OData API

67 Comments

 Previous 1 2 Next 

 You must be a registered user to add a comment. If you've already registered,

sign in. Otherwise, register and sign in.

Comment

Labels In This Area

ABAP CDS Views - CDC (Change Data Capture) 2 Advanced Event Mesh 1 ai 1

Analyze Workload Data 1 BS Reclassification 1 BTP 1

Business and IT Integration 2 Business application stu 1

Business Technology Platform 1 Business Trends 1,657 Business Trends​204

CAP 1 cf 1 Characteristics display 1 Classes 1 Cloud Foundry 1

Confluent 1 Customer COE Basics and Fundamentals 1

Customer COE Latest and Greatest 3 Customer Data Browser app 1

Data Analysis Tool 1 data migration 1 data transfer 1 Databricks 1

Datasphere 2 Event Information 1,396 Event Information​163 Expert 1

Expert Insights 178 Expert Insights​713 General 2 Getting Started 2

Google cloud 1 Google Next'24 1 GraphQL 1 Introduction 1 Kafka 1

Life at SAP 779 Life at SAP​42 MDG materials 1 MDGM 1

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 30/31
10/18/24, 12:19 PM OData API in SAP Cloud Integration for Beginners - SAP Community

Migrate your Data App 1 MLFlow 1 MTA 1 Network Performance Analysis 1

NodeJS 1 PDF 1 POC 1 Product Updates 4,564 Product Updates 769

Replication Flow 1 REST API 1 RisewithSAP 1 SAP BTP 1

SAP BTP Cloud Foundry 1 SAP Cloud ALM 1

SAP Cloud Application Programming Model 2 SAP Datasphere 2

SAP Datasphere ‫ تحقيق أقصى استفادة من بيانات األعمال‬1 SAP MDG Data Quality Management 1

SAP MDG DQM 1 SAP s4hana cloud 1 SAP S4HANA Migration Cockpit 1

Technical article 1 Technology Updates 6,864 Technology Updates​934

Workload Fluctuations 1

Related Content
An overview how to migrate clustered SAP instances 
in Technology Blogs by SAP 8m ago

CTMを使用したCloud Integrationの移送設定手順(How to Transport Cloud Integration

with TMS in Japanese) 
in Technology Q&A 19m ago

https://community.sap.com/t5/technology-blogs-by-sap/odata-api-in-sap-cloud-integration-for-beginners/ba-p/13389155 31/31