SAP Knowledge Base Article - Public

3017087 - Inconsistencies observed when querying picklist field values via OData API request - SAP SuccessFactors HXM Suite

Symptom

You're querying an entity which has some fields associated to a picklist.

Although both fields are configured the same way, the values returned do not follow a pattern. For one field, the picklist value option ID (numeric value) is returned, while for the other, the picklist value's label is returned. Using the example below, CountryWorkPlace returns the picklist value's option ID, while JobCategory returns the picklist value's label:

NOTE: 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 HXM Suite
    • OData API

Cause

Some entities do not have validation implemented for picklist fields. This means that it's possible (via import or API upserts) to set any value without resulting in error, causing such inconsistencies. So if you're observing this in your instance, it means some records were imported or upserted with wrong values.


Resolution

As stated in Query and Edit Behaviors of Entities with Picklist Fields, for legacy picklist fields (associated to the entity PicklistOption), you should upsert/import using the picklist value's option ID, and for MDF picklist fields (associated to the PickListValueV2 entity), use the externalCode.

This will avoid inconsistencies in the future. The page above also explains how to check the picklist field type using $metadata queries or the OData API Data Dictionary.

To correct existing records with such inconsistencies, simply upsert/import them again with the correct values (optionId or externalCode, depending on the picklist type).

Keywords

pick, list, picklist, picklistoption, option, label, picklistvaluev2, value, insert, update, inconsistency, inconsistent, faulty, data, issue, error, problem, records, record, user, employee, background, profile, incoherent, unpredictable, strange, behavior, query, request, call, returning, returns, returned, response, payload, incorrect, wrong, value, option , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HXM Suite all versions

Attachments

Pasted image.png