SAP Knowledge Base Article - Public

2637037 - Updating Candidate Profile Via ODATA API in SuccessFactors Recruiting

Symptom

  • This KB article explains how you can edit the Candidate Profile data via ODATA API.
  • Due to some requirements, clients need to make changes to some fields or even hide personal data from the candidate profile.
  • This is a common request after an instance refresh (action of copying the production data and configuration to a test/dev/QA instance).

Note: These changes will not work if the candidate is already anonymized.

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

  • In order to see what possible changes you can do using ODATA API, please refer to the ODATA API Reference Guide & ODATA API Data Dictionary in Admin Center.
  • As an example, we will be updating the name and resume of a candidate. The resume will be just a dummy file.
  1. The candidate is already existing in the system in this case, the name and resume will be updated by ODATA API.
  2. In order to construct the POST Request, we will need the candidate ID. This information can be found in the Adhoc Reports or in the Candidate Profile itself.
  3. Login to the Postman to construct the ODATA API call.

ODATA1.jpg

Request Breakdown:

a. Entity: CandidateLight

{
"__metadata":
{
"type": "SFOData.CandidateLight",
"uri": "CandidateLight(2683)"
},

Note: The number inside the () is the candidateId - CandidateLight(candidateId).

b. Properties: These are the field values you want to edit. Check the ODATA API Data Dictionary in Admin Center to see what properties you can update.

  1. We can see that the call was successful

odata2.jpg

  1. Also we can see the changes in the UI (both candidate name and attachment)

ODATA3.jpg

Note: In order to construct more calls using ODATA API, please use our ODATA API Reference Guide.

See Also

Keywords

sf, success factors, RCM, attachment, data dictionary, integration , KBA , LOD-SF-RCM-API , Webservices & APIs , LOD-SF-RCM , Recruiting Management , How To

Product

SAP SuccessFactors Recruiting all versions