SAP Knowledge Base Article - Public

3238251 - SFAPI to ODATA API Migration - Recruiting Management

Symptom

This article describes how to migrate SFAPI or SOAP-based integrations to ODATA API.

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."

Environment

SAP SuccessFactors Recruiting Management

Resolution

a. SFAPI services do not need to be turned off in provisioning. SOAP-based and ODATA-based integrations can coexist with one another.

b. Provisioning > Company Settings > 'Disable OData API' should not be checked. Note: If you have no access to provisioning, either let your partner verify this or reach out to Support.

The rest are changes on how the queries or payloads are created.

c. The integration payload or query URL should use ODATA entities and fields. ODATA entities and fields are available in the Admin Center > ODATA API Data Dictionary

d. The integration payload or query URL should use the ODATA endpoint URL. Note: The endpoint URL varies per data center. 

e. The full list of ODATA fields in SuccessFactors is in the ODATA Reference Guide.

f. The API user should have ODATA permissions. In Admin Center > Manage Permission Roles > [Role Name] > Permissions > Under Recruiting Permissions > ODATA API* permissions. 

g. The Metadata refresh and export options are in Admin Center > ODATA API Metadata Refresh and Export. 

  • Refresh - Used to refresh the ODATA API data when adding new reportable fields or when there are issues.
  • Export - Used to generate an xml containing the whole ODATA metadata file.

See Also

2817669 - ODATA API Data Dictionary - Recruiting Management
3191244 - What are the Available Reporting data for Recruiting in Recruiting V2 and ODATA API - Recruiting Management

2215682 - Successfactors API URLs for different Data Centers
SAP SuccessFactors HXM Suite OData API - Reference Guide

Keywords

ODATA, SFAPI, SOAP, ODATA API, Data Dictionary, Recruiting Management, RCM, Integration, Migration , KBA , LOD-SF-RCM-API , Webservices & APIs , How To

Product

SAP SuccessFactors Recruiting all versions