OData Services in SAP

This page provides detailed information on standard and custom OData services in SAP, including entity sets, operations, and implementation details.

Understanding OData Services

OData services in SAP are RESTful APIs that expose SAP data and functionality to external applications. Each service:

Has a unique service name and namespace
Contains one or more entity sets (collections of entities)
Defines the data model using metadata
Supports standard HTTP methods (GET, POST, PUT, DELETE)

Service Structure

Service Document

The service document lists all available entity sets in the service. It is accessed by requesting the service root URL:

https://<server>:<port>/sap/opu/odata/SAP/ZGWSAMPLE_SRV/

Metadata Document

The metadata document describes the data model of the service, including entity types, properties, and relationships. It is accessed by appending $metadata to the service root URL:

https://<server>:<port>/sap/opu/odata/SAP/ZGWSAMPLE_SRV/$metadata

The metadata document includes:

Entity types and their properties
Complex types
Associations between entity types
Function imports (actions)
Annotations

Entity Sets

Entity sets are collections of entities of a specific type. They are accessed by appending the entity set name to the service root URL:

https://<server>:<port>/sap/opu/odata/SAP/ZGWSAMPLE_SRV/SalesOrderSet

Standard SAP OData Services

SAP provides numerous standard OData services for various business domains:

Business Suite / ERP Services

Service Name	Description	Key Entity Sets	Usage
GWSAMPLE_BASIC	Sample service for demonstration	BusinessPartnerSet, ProductSet, SalesOrderSet	Learning and testing
API_BUSINESS_PARTNER	Business Partner API	A_BusinessPartner, A_Customer, A_Supplier	Manage business partners
API_SALES_ORDER_SRV	Sales Order API	A_SalesOrder, A_SalesOrderItem	Manage sales orders
API_MATERIAL_DOCUMENT_SRV	Material Document API	A_MaterialDocumentHeader, A_MaterialDocumentItem	Manage material documents
API_PURCHASEORDER_PROCESS_SRV	Purchase Order API	A_PurchaseOrder, A_PurchaseOrderItem	Manage purchase orders

S/4HANA Services

Service Name	Description	Key Entity Sets	Usage
API_BUSINESS_PARTNER	Business Partner API	A_BusinessPartner, A_Customer, A_Supplier	Manage business partners
API_PRODUCT_SRV	Product API	A_Product, A_ProductDescription	Manage products
API_SALES_ORDER_SRV	Sales Order API	A_SalesOrder, A_SalesOrderItem	Manage sales orders
API_PURCHASE_ORDER_SRV	Purchase Order API	A_PurchaseOrder, A_PurchaseOrderItem	Manage purchase orders
API_BANK_SRV	Bank API	A_BankDetail, A_BankDirectoryEntry	Manage bank data

SAP Gateway Foundation Services

Service Name	Description	Key Entity Sets	Usage
CATALOGSERVICE	Service catalog	ServiceGroups, ServiceReferences	Browse available services
METADATA	Metadata repository	Namespaces, Services, EntityTypes	Explore service metadata
USERMANAGEMENT	User management	Users, Roles	Manage users and roles

Create a new project in Transaction SEGW
Define the data model (entity types, properties, associations)
Generate the runtime objects
Implement the required methods (GET_ENTITY, GET_ENTITYSET, etc.)
Register the service in Transaction /IWFND/MAINT_SERVICE

ABAP RESTful Programming Model (RAP)

Define business objects using CDS views
Create behavior definitions and implementations
Expose the business objects as OData services
Register the service in Transaction /IWFND/MAINT_SERVICE

Implementation Details

Data Provider Class

The data provider class implements the methods required to handle OData requests:

CLASS zcl_zsample_dpc IMPLEMENTATION.
  METHOD /iwbep/if_mgw_appl_srv_runtime~get_entityset.
    CASE iv_entity_name.
      WHEN 'Customer'.
        " Retrieve customer data
        SELECT * FROM kna1 INTO TABLE @DATA(lt_customers)
          UP TO 100 ROWS.
          
        " Convert to OData format
        LOOP AT lt_customers INTO DATA(ls_customer).
          APPEND INITIAL LINE TO et_entityset ASSIGNING FIELD-SYMBOL(<fs_entity>).
          MOVE-CORRESPONDING ls_customer TO <fs_entity>.
        ENDLOOP.
        
      WHEN 'SalesOrder'.
        " Retrieve sales order data
        " ...
    ENDCASE.
  ENDMETHOD.
  
  METHOD /iwbep/if_mgw_appl_srv_runtime~get_entity.
    " Implementation for retrieving a single entity
    " ...
  ENDMETHOD.
  
  " Other methods for create, update, delete operations
  " ...
ENDCLASS.

Model Provider Class

The model provider class defines the data model of the service:

CLASS zcl_zsample_mpc IMPLEMENTATION.
  METHOD define.
    " Define Customer entity type
    DATA: lo_entity_type TYPE REF TO /iwbep/if_mgw_odata_entity_typ.
    
    lo_entity_type = model->create_entity_type( 'Customer' ).
    lo_entity_type->set_keys( VALUE #( ( 'CustomerID' ) ) ).
    
    lo_entity_type->create_property( 'CustomerID' )->set_type_edm_string( ).
    lo_entity_type->create_property( 'CustomerName' )->set_type_edm_string( ).
    lo_entity_type->create_property( 'City' )->set_type_edm_string( ).
    lo_entity_type->create_property( 'Country' )->set_type_edm_string( ).
    
    " Create entity set
    model->create_entity_set( 'Customers' )->set_entity_type( 'Customer' ).
    
    " Define other entity types and sets
    " ...
  ENDMETHOD.
ENDCLASS.