SAP Knowledge Base Article - Public

3487010 - "Please add required properties in payload. Required property <fieldName> is missing" error - OData API/Integration Center

Symptom

You are trying to insert/upsert data in SuccessFactors but you are facing the error below:

  • "COE_MISSING_REQUIRED_PROPERTIES"
    "[COE0027]Please add required properties in payload. Required property <fieldName> is missing. You can check which properties are required for an entity in Admin Center > OData API Data Dictionary or the entity metadata."

NOTE: The same symptom may also occur in Integration Center as it runs based on the OData API engine.

Environment

SAP SuccessFactors HCM Suite

Cause

  1. The <fieldName> required field is missing in the payload;
  2. The <fieldName> required field is included in the payload but is being set to "null" and is not nullable;

All SuccessFactors entities have mandatory fields when creating records that can be nullable or not. In order to know that, you can go to OData API Data Dictionary, select the related entity, and look at the "required" or "nullable" columns. For more details, refer to OData API Data Dictionary chapter.

Resolution

  1. Ensure that the required field is in the request payload;
  2. Ensure that a valid value is being passed for the required field;

NOTE: There are some specific scenarios with different resolutions. Please, refer to the See Also section.

See Also

  • KBA 3006179 - Error when inserting data into startDate or endDate fields from a Background entity - Integration Center
  • KBA 2993786 - Error when sending "NO_HR" value in "hr" field on User Upsert - OData API
  • KBA 3307746 - While performing UPSERT operation on User entity where NO_MANAGER value is passed in userId field, API server throws httpCode 500 error and asks to add required properties in payload

Keywords

insert,upsert,create,add, data, SuccessFactors, sf, COE_MISSING_REQUIRED_PROPERTIES, COE0027, Please add required properties in payload, are missing, you can check which properties are required for an entity in Admin Center, OData API Data Dictionary, Integration Center, null , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-INC , Integration Center , Problem

Product

SAP SuccessFactors HCM suite all versions