SAP Knowledge Base Article - Public

2886573 - OData API Query Pending Hires

Symptom

You wish to retrieve data for an employee created but not yet hired (Pending Hires) using OData API

Environment

 SuccessFactors

Resolution

Since b1905, a new indicator property "hiringNotCompleted" has now been introduced in the EmpEmployment entity to differentiate the data records of onboardees that have been created through Onboarding 2.0 but didn't complete the "Manage Pending Hire" process. You can filter on this property to retrieve data for hired employees and the aforementioned onboardees separately.

For onboardees who has not completed the "Managing Pending Hires" step, the value of this property is true. For hired employees, the value of this property is false.

Example OData API GET call to retrieve pending hires:

https://<API-Server>/odata/v2/EmpEmployment?$format=JSON& $filter=hiringNotCompleted eq 'true'& $select=personIdExternal,userId,hiringNotCompleted

See Also

 SAP SuccessFactors Employee Central OData API: Reference Guide

Keywords

OData API, Mange Pending Hires, hiringNotCompleted, Onboarding 2.0 , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-OBD-API , Webservices & API's , How To

Product

SAP SuccessFactors HXM Suite all versions