Executing OData API Calls

Objective

After completing this lesson, you will be able to use a simple OData API from a browser.

Introduction

The following contents covers an overview of the EC OData API Call & Tools.

Recorded Webinar: EC OData API Basics

API Tools in HCM

The below diagram shows us the basic differences between OData API and Compound Employee API. It is very clear that OData API has more tools and applicability than Compound Employee API.

OData involved: Includes Integration Center, API Logs, API Dictionary, API Metadata Export and Refresh

SOAP involved: Includes API Logs, API Dictionary.

Diagram illustrating data flow between Integration Center, OData, SOAP, and External Consumers like Hana Cloud Platform, with API components.

OData API Call from Browser

OData API Dictionary

OData API Log

Refresh and Export Metadata

Important to know!

When someone updated the object or customer fields in SAP SuccessFactors, it should be refreshbefore you can use it, so the refresh can refresh the metadata cache. The updated metadata will be regenerated, and saved into the cache, also it is available for future operations such as export. Sometimes we need to view or update the metadata for a large amount, it is better to export the metadata to view or update, so the export can export and download the metadata. The defaultexport file name is CompanyName-Metadata.xml, there are still some important tips we should know:

Stores a cache of the OData API metadata
This cache gets out of sync with the data model after changing it
Manual Refresh is strongly recommended to avoid issues
In case of suddenly appearing issues with OData APIs try a refresh first

Admin Center page for OData API Metadata Refresh and Export, featuring options to refresh metadata cache and export metadata.

Integration Center

The Integration Center is designed for simple file-based outbound integrations. It provides for commonly needed filters, field formats, transformations, mappings,and file types.

Admin Center interface showing three options: My Integrations, Monitor Integrations, and Data Model Navigator for managing integrations efficiently.

Features

Part of the Integration Center
Displays OData Entities and their Fields/Navigations between each other
Allows export and import of configured model and also export as PNG
Can display IDs and labels for resource attributes
Supports auto expand to next entities

Data Model Navigator interface showing entity relationship diagram with selectable entities list for display customization in SAP environment.

Admin Center - API Center

The central place to manage APIs

View Data Dictionaries
Configure and view audit logs
Configure security
View API usage
Refresh $metadata

Role-based Permissions required

Manage Integration Tools

Access to SFAPI Audit Log
Access to SFAPI Metering Details
Access to the SFAPI Data Dictionary
Manage OAuth2 Client Applications
Access to OData API Audit Log
Access to API Option Profile

Access to OData API Metadata Refresh and Export Access to OData API Data Dictionary.

Manage OData API Basic Authentication
Access to Outbound Trust Manager
Access to API Center

API Centre interface with options for OData configuration, management, and legacy SFAPI features. Note about SFAPI deprecation.

Set Up and Explore OData API and Tools in SAP SuccessFactors Employee Central

ExerciseStart Exercise

Process Overview

This simulation demonstrates the basic configuration steps required to manually set up the configuration for SAP SuccessFactors Employee Central. You will get the basic knowledge of OData API call & Tools. How to monitor the APIs for different partners.

Prerequisites

The following configuration and customization must have been completed before implementing Basic Settings in SAP SuccessFactors.

Access to OData SFAPI
Access to Audio Log
Access to API Tools

Result

As part of this demonstration, we will cover configuration section in EC - Simple API Call & Tools.

Go to Course