SAP Knowledge Base Article - Public

3672638 - Data not returning for specific fields even with permission access to the affected fields - SuccessFactors OData API

Symptom

  • You noticed that data is not returned for some entities/fields, even though the API User permission role has been configured to give access to the affected entities and the fields being queried.
  • Adding the Employee Central HRIS OData API permission allows data to be returned, but this returns all fields, apart from being an admin permission, which is not the intended behavior.

Environment

  • SAP SuccessFactors OData API

Reproducing the Issue

  1. Configure a permission role to give access to specified fields on the affected entities.
  2. Add the permission role to the API user.
  3. Call the OData API using OAuth for the affected entity. In this example we will use EmpEmployment as example, and try to query random fields like employeeClass, businessUnit, emplStatus etc. 
  4. Even though the API User has those fields included in his permission role, the data available in SF is not returned. 

Cause

  • Some fields are considered key to each entity for permissions to work correctly. One (or more) key fields are missing from the RBP Permission role.

PS: another possibility is that the users being queried are not within the Target Population of the API User, but that cause and according solution will not be covered in this KBA.

Resolution

To ensure all fields are returned properly, you need to grant permission to the business key fields of the entity that you are querying. In the above example, we were using EmpEmployment (Employment information) entity.

So for that entity, you need to ensure that field "Employment Details > Employment Details MSS" are granted access in the permission role.

Once that field has been added to the permission role, the other fields from the affected entity will return data as expected. 

See Also

Keywords

odata api, role-based permissions, sap successfactors, employee central, oauth, permission role, target population, api user, employment information, personal information, job information, hris odata api, access restriction, key fields, data not returned, business key field. , KBA , LOD-SF-INT-ODATA , OData API Framework , Problem

Product

SAP SuccessFactors HCM Suite all versions