SAP Knowledge Base Article - Public

3016954 - Succession Planning OData API Entities and Services

Symptom

What are the supported OData entities and services which are supported for use in relation to Succession Planning?

Environment

SAP SuccessFactors Succession Planning

Cause

The Succession OData API entities enable customers to build custom extensions on standard SAP SuccessFactors application Succession Planning. The most common need for customers is the ability to create alternate visualizations on top of the succession data. To allow customers to do that, we have exposed the following data in Succession Planning:

  • Successor Data
  • Incumbent Data
  • Position Data
  • Talent Flag information
  • Icon/gradient configuration from the XML
  • Trend data

You can access successors in both MDF Position and legacy Position only when you have succession planning permission for those positions. You can also access all members and individual nomination details in a talent pool if you have the permission.

Resolution

The current list of supported OData v2 entities which relate to Succession Planning are;

  • LegacyPositionEntity
  • Nominee History
  • NominationTarget
  • Successor
  • TalentGraphicsOption
  • TalentPool

Some entities may not be supported for use based on the system configuration, for example LegacyPositionEntity is only supported for use with systems that have the Legacy Position nomination method.

You can use the OData v2 API function import to approve or reject nominees that are in a pending status. The pending status consists of Change Pending, Deletion Pending, and Pending.

  • approveSuccessors
  • rejectSuccessors

For a full overview of Succession OData v2 and the permissions associated to it please check the SAP SuccessFactors OData V2 API Reference Guide.

The OData V4 service NominationService allows you to perform the following actions for MDF Position based nominations;

  • Create Nominations
  • Update Nominations
  • Delete Nominations

Full details on the service such as prerequisites examples and error codes can be seen in the SAP SuccessFactors OData V4 API Reference Guide.

Note: If you require further assistance in regrads consultation or eduction of how to correctly use these entities within your own application or project, please use our Partner specific tools or contact Professional Services.

Keywords

Succession, Management, OData, API, Integration, Center, Dictionary, Entity, SF, middle. operation, v2, v4, permission, error, service, KM-19322 , KBA , LOD-SF-SCM-INT , PM, GM, RCM, EC, TIH, etc. , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors Succession & Development all versions