Symptom
Work Permit data is not returning for some employees in OData API.
The following conditions have been confirmed, yet the data is still not returned:
- The work permit data is visible in the employee's profile.
- The API user has the required admin permissions to access all Employee Central data.
Environment
- SAP SuccessFactors HCM Suite
- OData API
Cause
All fields marked as "Part of business key. Cannot be empty." on the EmpWorkPermit page must contain a value. Some of these fields are not defined as nullable=false in the metadata, which means a blank value is technically allowed at the data layer. However, if any business key field contains a blank value, the EmpWorkPermit record is excluded from the API response.
Resolution
Ensure that all business key fields for the EmpWorkPermit entity contain a non-blank value. The required fields are:
- userId
- country
- documentType
- documentNumber
- issueDate
See Also
SAP Help Portal - EmpWorkPermit
Keywords
Integration Center, OData API, EmpWorkPermit, Work Permit, missing, null, blank, business key, document number, documentType, documentNumber , KBA , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , Problem
SAP Knowledge Base Article - Public