SAP Knowledge Base Article - Public

2795839 - Check tool SFAPI feature status - Q2 2019 enhancement API-11370 - SAP SuccessFactors HCM Suite


In the Q2 enhancement 2019 our team have added a new check for SFAPI in the Check Tool. You can run the SFAPI feature status check (Check ID: SFAPIIsTurnedOn) under API > Check SFAPI to see whether SFAPI is turned on in your instance. Please note that SFAPI, excluding Compound Employee, was deprecated as of August 1, 2018. We encourage you to use OData for new development and move your legacy applications and integrations to OData.

You would like to know more details about this process.


  • SAP SuccessFactors HCM Suite - SFAPI
  • SAP SuccessFactors HCM Suite - Check tool

Reproducing the Issue

  1. Admin Center > Check tool
  2. Select "API" in the dropdown and mark to select the fields > click in the "Run 1 check" button
  3. You will see similar message according the screenshot below:


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


The functionality delivered in the API-11370 tells you in the Check tool if the SFAPI is enabled or not.

The SFAPI CompoundEmployee entity is the only one in SFAPI that will not be deprecated. This is written in the KBA 2682094 - Deprecation of Partner API, SFAPI Adhoc and SFAPI for Simple Entities

 Inside the "Admin center > SFAPI Data Dictionary" > we can see the word "Deprecated" in red color in the right side of the names of all entities that will be deprecated. You will also see this message below:

  • Please Note - SFAPI is deprecated as of August 1, 2018. Please use OData for new development and consider moving your legacy applications and integrations to OData. For more information please refer to" 


Checking the handbook in our help portal, direct link ( Deprecation of Partner API, SFAPI Adhoc and SFAPI for Simple Entities ).

We have the following details in the pages 6 and 7 regarding the dates when this will happen.


Will the API be removed from productive environments once deprecated?

No. This will only occur when the API is decommissioned and that will occur no sooner than 1 year from the
deprecation announcement date.


Is the SFAPI listed in the API Center (Admin Center) as deprecated?
Yes, it is listed


If an API is deprecated, is it unsupported?
No. We’ll continue to support SFAPI and provide bug fixes during the deprecation period. However, we’ll no longer
develop new functionalities for deprecated APIs, and all support will be stopped when an API is decommissioned.


How are APIs deprecated?
API deprecation can occur on a single function or data entity as well as an entire class/protocol of APIs.


How will I know if my tenant is using deprecated APIs?
In future, we will indicate using the Configuration Check tool if you have deprecated APIs turned on in your tenant.
We can also provide indication of deprecated APIs you may be using in your tenant.


What is our policy around APIs?
APIs that have been used for more than 24 months may be deprecated to improve the quality and functionality of
our APIs. Our API policy states that:


  • We will not deprecate an API sooner than 2 years after initial release;
  • We will not decommission an API sooner than 1 year after deprecation; and
  • We may announce decommissioning sometime after deprecation and at least 1 year prior to the decommission date.


We respect our customers and your reliance on API, so we will evaluate the usage of the APIs before we
decommission. The primary goal of deprecation is to stop new development on old APIs and encourage moving
to OData. Currently, we have no set date for decommissioning. But when announced, we will provide at least
one year's notice prior to the decommission date.




For your knowledge, all entities available in the OData can be seem in the handbooks below:




You can start checking the "Admin Center > SFAPI Audit logs" and identify the calls done in your SF Instance.


Later, you can open the HTTP request header and check the IP addresses where this came from, like middleware's SAP HCI or Dell Boomi. After that, you can identify your processes running these SFAPI queries and start evaluating the correspondent entity in OData to migrate.


See Also

KBA 2682094 - Deprecation of Partner API, SFAPI Adhoc and SFAPI for Simple Entities


Q2 2019 enhancement API-11370 - SAP SuccessFactors HCM Suite, Check tool SFAPI feature status, SFAPIIsTurnedOn, CompoundEmployee, Admin Center > SFAPI Audit logs, API deprecated, decommission , KBA , successfactors check tool , sfapi deprecation , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-CE , Compound Employee API , Product Enhancement


SAP SuccessFactors HCM Core 1905 ; SAP SuccessFactors HCM suite all versions