# SAP OData Connector

Microsoft provides Open Data Protocol (OData) to facilitate data exchange over the Internet. This specification is approved by both the International Organization for Standardization (ISO) and the International Electrotechnical Commission (IEC), and adheres to REST (Representational State Transfer) architecture, which in turn relies on the HTTP protocol. SAP has integrated OData support into SAP NetWeaver Gateway. SAP NetWeaver includes tools for designing, implementing, deploying, and testing OData services. You can use the SAP OData connector to connect to SAP On-premise (SAP Business Suite applications) and the SAP S/4HANA Cloud, Public Edition instance. This connector allows you to work with the hundreds of OData APIs out-of-the-box to interact with data sources that include purchase orders, requisitions, invoices, and products. This connector is also compatible with all custom OData services available to set up on your instance.

# API version

Standard actions in this connector support the SAP API Business Hub family of OData APIs (opens new window) and custom OData services that use the V2 specification. SAP OData connector supports various authentication types to secure the communication between systems.

# Triggers & Actions

This connector supports the following triggers and actions:

  • New object
  • New/updated object
  • Create object
  • Update object
  • Search object
  • Get object details by ID

# Supported object types

The available object types depends on your selected service. The service you provide in the action or trigger configuration will dictate what objects show in the Object dropdown.


The service you provide must be enabled for the communication user you have given in your connection. You enable new services by creating new Communication Arrangements in S/4HANA that link communication users to communication scenarios.

For example, providing the API_PRODUCT_SRV service in the Service input field will allow you to select all object types defined for that service.

List of service objects

Selecting a specific object will then cause more input fields specific to that object to appear. You can then start mapping datapills to these objects.

Object specific fields

When retrieving or mutating records in SAP OData services, you may want to interact with both the record as well as records related to it. For example a customer record as well as it's related addresses. To do so, you can utilize the related records input field that is present in every action. This input field is a multiselect tree dropdown that allows you to select related children records, and even grandchildren records.

After selecting this input, new input fields will be shown (for create/update actions) and new output fields (for triggers, search and get actions). This allows you to minimize job execution time and reduce recipe complexity.

# Enable the catalog service

Workato provides users with the choice to either select OData services from a dropdown menu or manually enter the service name when creating an action. Consider the following for enablement of this feature in Workato:

  • To enable this feature on SAP On-Premise Business Suite applications through OAuth2.0 authentication, add scope /IWFND/SG_MED_CATALOG_0002 in the Workato connection field Scopes additionally (comma separated) and in transaction code SOAUTH2 while provisioning scopes to the OAuth2.0 Client ID.
  • To enable this feature on SAP S/4HANA Cloud, assign communication scenario (opens new window) SAP_COM_0449 to the communication user.


The catalog service is not supported if you are using OAuth BTP authentication to connect with SAP S/4HANA Cloud, Public Edition.

# Additional capabilities

SAP OData provides additional support for the following capabilities:

  • Create, Update, Delete, Get, Query, and Replace operations on the selected entity.
  • Query options for: $expand (select navigation properties), $select(select required fields in response), $filter, $orderby, $top, and $skip.
  • OData endpoints consumption.
  • Pagination.
  • OData APIs protected using OAuth Authorization Code Grant, OAuth 2.0 SAML Bearer Assertion, Client Certificate-Based, and Basic Authentication.
  • Connection capabilities to any SAP on-premise application, including those behind a corporate firewall, using On-prem agent.

Last updated: 4/10/2024, 4:19:13 PM