2527211 - OData API Option Profile for User Entity

• How to manage API option profile ID's
• How to Send Welcome Message to New users using created ODATA API option ProfileID

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Successfactors

1. Access and Creation of API Profile ID (API profile ID management)

2. Go to Admin Center and search Manage API Option Profile

3. Add a Profile ID with the Entity Type

 Using User entity parameter enabled for the Profile ID e.g SendWelcomeMessage using User Entity Parameter

If you use a saved API profile, add the parameter, apiOptionProfileID at the end of an insert/upsert URL.

Currently this functionality is available only for the User entity as shown: http://<hostname/API endpoint URL>/odata/v2/User?apiOptionProfileID=option001 where option001 is a saved option profile.

e.g. https://<hostname/API endpoint URL>/odata/v2/User?apiOptionProfileID=XXXX&sendWelcomeMessage=1

Other Supported Parameters

PARAMETER	DESCRIPTION
sendWelcomeMessage	Send welcome email to new users.
validateMgrHr	Validate Manager and HR fields.
managerTransfer	Automatically insert new manageras next document recipient if not already
routeInboxDoc	Manager – Automatically transfer inbox documents to new manager
routeEnRouteDoc	Manager – Automatically route enroute documents to new manager.
routeCompletedDoc	Automatic Completed Document Copy to New Manager
managerOnlyCompany	Manager –Automatically route copy of completed documents to new manager.
removeInProgressDocsForInactiveUsers	Remove documents with status In-Progress for Inactive Employees
removeCompletedDocsForInactiveUsers	Remove documents with status Completed for Inactive Employees
defaultPasswordField	Set a new user default password field.

Note : Currently this functionality is available only for the 'User' entity

 KBA 2215682 - Successfactors API URLs for different Data Center

• Manage OData API Option Profile
• API Option Profile ID
• User Entity, Send Welcome Message
• How to manage API option profile ID's
• How to Send Welcome Message to New users using created ODATA API option ProfileID

, KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-API , API & Adhoc API Framework , How To

SAP SuccessFactors HCM Core 1705 ; SAP SuccessFactors HCM Suite all versions