SAP Knowledge Base Article - Public

2768078 - SFOdata User Entity Update, Insert, Upsert Inactive Employee How to

Symptom

How to process Status='Inactive' User via Odata API upsert, insert

Environment

 SAP Successfactors HCM Core

Cause

By default users with inactive status are not available for write operations (create/modify) in Odata API.

Resolution

In the User entity, statuses inactive(f) and inactive_external (F) indicate users that are inactive in the company. To be able to do perform write operations, you must include one of the following parameters in your request:

  • Parameter apiOptionProfileID

    In the Manage API Option Profile tool, enable the Process Inactive Employees option and include the corresponding option profile ID as the parameter value in the request. Example:

         https://<hostname>/odata/v2/User?apiOptionProfileID=option001 (for list of correct host name see 2215682 - Successfactors API URLs for different Data Centers)

For more information, see Managing User API Options.
  • Parameter processInactiveEmployees

    You can also use parameter processInactiveEmployees for the same purpose. This parameter supports Upsert, Insert, and Update operations. When used in conjunction with $batch, you can create new and update existing inactive users as well as active users.

    Example: https://<hostname>/odata/v2/User("key")?processInactiveEmployees=true (key is userId as business key)

Note :

The Effective Dated Data Platform feature must be enabled in order for these parameters to work.

You can use both options in the same query. Inactive users will be processed when either option allows it.

See Also

SAP SuccessFactors Employee Central OData API: Reference Guide

Keywords

SFOdata.User Upsert, SFOdata.User Insert, apiOptionProfileID,  processInactiveEmployees , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , How To

Product

SAP SuccessFactors HCM Core all versions