SAP Knowledge Base Article - Public

2569249 - How to insert a Candidate without providing all the required fields configured in the Candidate Profile Template with OData API

Symptom

  • How to insert a candidate in RCM module without providing all the required fields configured in the Candidate Profile template? 
  • How to create a new candidate via OData API with the minmum number of fields?

Environment

SAP SuccessFactors Recruiting Management

Resolution

Recruiting Management module has launched a new OData API entity named CandidateLight.

The CandidateLight entity allows a user to query, insert and update the candidate profile. It contains all core candidate profile data consisting of system, standard and custom fields. The metadata will show the standard and custom fields configured in the active template. If a field (standard or custom) is not configured in the template, then it will not show up in the metadata and not be a part of oData query. The system fields will always show up.

Compared to the existing candidate entity it provides exactly the same functionality but the validation of mandatory fields is different, fewer mandatory fields are available. With this new entity, it is possible to insert candidate data without providing all the mandatory fields configured in the Candidate Profile template. The basic fields are: firstName, lastName, primaryEmail, country. These 4 fields are mandatory for any CandidateLight API insert.

Please see an example below:

POST: https://apisalesdemo4.successfactors.com/odata/v2/CandidateLight

{
"primaryEmail": "example@yopmail.com",
"firstName": "John",
"lastName": "Smith",
"country": "US"
}

See Also

CandidateLight 

Keywords

candidate, entity, CandidateLight, upsert, insert, Odata, API , KBA , LOD-SF-RCM , Recruiting Management , Problem

Product

SAP SuccessFactors Recruiting all versions