Configuring Select Parameters

Objective

After completing this lesson, you will be able to demonstrate how to apply select parameter and interpret the results.

Introduction

The following contents covers an overview of the SAP SuccessFactors Compound Employee API Select Parameters in Query.

Compound Employee API - Select Parameter Basis

We always use Select Parameter when we use Compound Employee because of the following:

  • To be used if results for employee shall be restricted
  • Returns employees that meet the select criteria in the current and historic data
  • Combined always with ‘AND’ operator

For example we only want to extract the employee data which is belong to the company of "US", we can limit the company equal ‘US’, then the response/result will be the US employee.

Person_ID_external

Last_modified_on

Start_date

Company

Country

Department

Compound Employee API - Select Parameter Example

Select the play button to watch examples of the Select Parameter.

Compound Employee API - Filter Parameters

  • Filter: Effective_End_Date
  • Filter parameter decides, which data is transferred for selected employees
  • Filter doesn’t reduce number of relevant EE’s

We always use Effective_End_Date as the filter parameter. It can decide which data will be transferred for the selected employee data, but the filter parameter will not reduce the number of relevant employees.

Select the play button to watch an example of Select parameter with Filter parameter.

Compound Employee API - Select Parameter specifics

  • Select Parameter: last_modified_on

    Only receive employees that have changed since this point in time Changes include deletions.

  • Deleted segments are not part of the response

    Person_ID_external

    Last_modified_on

    Start_date

    Company

    Country

    Department