SAP Knowledge Base Article - Public

2318047 - resultOptions parameter in Compound Employee API

Symptom

This KBA provides a list of all the values supported by the parameter 'resultOptions' of the Compound Employee API.

Environment

Successfactors

Resolution

resultOptions - This parameter is used to switch between different options on how much data shall be returned in the response.

  • “allJobChangesPerDay” - If specified the API returns all job information slices that result from multiple job changes per day. Normally, in case there are several job slices with the same start date, the API does not return all job slices. It only returns the job slice with the highest sequence number because it contains the valid business data. If the parameter value is specified, the consumer gets all job slices and consequently knows about the historic changes and the events that triggered each of the changes. The parameter value is not supported in case the queryMode parameter is set to “Delta”.  
  • “allCompensationChangesPerDay” -  If specified the API returns all compensation information slices that result from multiple compensation changes per day. As a result the consumer consequently knows about the historic changes and the events that triggered each of the changes. The parameter is only supported if the performance improved render mode is switched on. The parameter value is not supported in case the queryMode parameter is set to “Delta” or when using the old render mode.  
  • “changedSegmentsOnly” - If specified, the API returns only changed segments with an action code not equal to ‘No Change’ in delta transmission. The parameter value is only supported in case the queryMode parameter is set to “delta”.  
  • “changedFieldsOnly” - If specified, the API returns only changed fields of a changed segment. The parameter value is only supported together with “changedSegmentsOnly” and in case the queryMode parameter is set to “delta”.  
  • “isNotFirstQuery” The parameter value is only supported in case the queryMode parameter is set to “delta” in combination with “fromDate” and “toDate” select parameter. For further information be referred to the separate delta transmission handbook. 
  • “extendedConsistencyChecks” - If specified, the API conducts in delta transmission additional validations for dates of time slices and errors out for effected employees in cases of overlapping time slices or gaps in between time slices where no gaps are allowed. For the affected employees a log entry gets returned containing the severity ‘ERROR’. 
  • “xsd” If specified, the API generates the XSD for the response message. The XSD can be used in the middleware to generate the profile for the interface.

Keywords

KBA , LOD-SF-INT-API , SF API & Adhoc API Framework , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , How To

Product

SAP SuccessFactors HCM Suite all versions