Understanding API Modes Functionality

The following contents covers an overview of the SAP SuccessFactors Compound Employee API Query Modes.

Select the play button to watch an overview of the different modes.

To run the Compound Employee API in different modes we need provide the specified parameters.When using full mode we do not need to provide any parameter because it is the default mode for Compound Employee API and it returns the current data of the employees including all time frames. When using the snapshot mode, we need to provide the parameter (queryMode equals snapshot) here, it returns the data of the employees as it was on a certain date in the past. When using the delta mode, we also need to provide the parameter (queryMode=delta) here, it returns the changes that have happened since a certain point in time.

The Full transmission extracts all the data which is related to the employee data in the system. This includes all time slices, historic data, and future dated records, and the most important point is the consumer can react based on the data provided, if the data was changed or deleted, the consumer needs to consider what has happened with the data and react accordingly.

• Complete data set of an employee is returned in Compound Employee API response.
• This includes all time slices, historic data, and future dated records.
• Consumer can react based on the provided data.

• To be used if "as of date" employee data is of interest.
• Returns exactly the state of employee data at a given point in time.
• Supports HRIS & MDF based segments.

Returns changed data for employees happened. There are 2 different modes for Delta Transmission.

• Since a given point in time (effective-dated delta transmission).
• That is relevant for a given period (period-based delta transmission.

Delta is based on field-based delta calculation

• Indication of changed fields including previous values
• Delta transmission requires audit data

  • Auditing needs to be switched on ideally from beginning

• Intended for Small employee population for a country.
• Is based on Compound Employee APIs delta transmission modes.

• The per_person segment of the Compound Employee API has been enhanced by the new field PERSON_GUID the uniquely identifies a person. It is filterable and sortable.
• We’ve introduced the concept of a person UUID (unique universal identifier) for the entire SAP SuccessFactors HCM Suite; when a new hire or user is created, the system generates this identifier – called "perPersonUuid".

  perPersonUuid lets you expose the person UUID for integration and import scenarios for all employees (EC and non-EC employees). The field is visible and upsertable in PerPerson but cannot be queried via this entity.