SAP SuccessFactors HCM Suite OData API: Reference … · Reference Guide PUBLIC SuccessFactors...

Reference Guide PUBLICSuccessFactors FoundationDocument Version: Q2 2018 2018-05-18

SAP SuccessFactors HCM Suite OData API: Reference GuideAn Entity Reference

Content

1 What's New in This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2 About HCM Suite OData APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

3 Using This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4 OData Metadata Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344.1 EntitySet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354.2 AssociationSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364.3 Property (Deprecated and Removed). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364.4 NavigationProperty (Deprecated). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374.5 Metadata Enhancements for UI5 Smart Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384.6 Retrieving metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

5 Common Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445.1 Attachment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445.2 CompanyProvisioner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505.3 CompetencyRating. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515.4 Country. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545.5 Currency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565.6 CurrencyConversion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575.7 ExternalLearner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595.8 ExternalLearnerAddressInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625.9 ExternalLearnerEmailInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625.10 ExternalLearnerPersonallInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .625.11 ExternalLearnerPhoneInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .625.12 ExternalUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635.13 ExtPersonalInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.14 ExtPhoneInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.15 ExtEmailInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.16 ExtAddressInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .685.17 Photo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.18 PickListValueV2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745.19 PickListV2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755.20 TimeZone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775.21 ToDo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785.22 TodoEntryV2 (Beta). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875.23 User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

2 P U B L I CSAP SuccessFactors HCM Suite OData API: Reference Guide

Content

Business Rules for API Based File Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102UserAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

5.24 Function Imports for Common Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108validateExternalUserIdAndUsername. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108getUserNameFormat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108validateExternalUserPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109getPasswordPolicy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110getExtEventMetaDataDefinition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110getSPMetadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

5.25 Audit Log Payloads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

6 Role Based Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146.1 RBPRole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156.2 RBPRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176.3 DynamicGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196.4 DGPeoplePool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1226.5 DGFilter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236.6 DGExpression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246.7 DGField. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256.8 DGFieldValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1276.9 DGFieldOperator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1286.10 RBPBasicPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296.11 Custom Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

7 Employee Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1407.1 Current Dashboard Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1407.2 EPProfileView. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1407.3 EPProfilePortlet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417.4 EPProfileUserInfoPortlet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427.5 EPPublicProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1437.6 BadgeTemplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447.7 UserBadges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1457.8 Background. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

8 Execution Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518.1 EMEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518.2 EMEventAttribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1588.3 EMEventPayload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1608.4 EMMonitoredProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

9 Goals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1669.1 COTGMObjectiveEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1669.2 COTGMMilestoneEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

SAP SuccessFactors HCM Suite OData API: Reference GuideContent P U B L I C 3

9.3 COTGMMLTEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1729.4 COTGMCommentEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1729.5 GoalPlanTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1739.6 GoalEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1759.7 SimpleGoal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

10 Job Profile Builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18310.1 CompetencyEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

CompetencyEntity: Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Competency Entity Object Modeling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

10.2 CompetencyType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407CompetencyType: Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

10.3 WorkerCompetency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469WorkerCompetencyAssessment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

10.4 Organizing Job Profile Builder Competencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48810.5 FamilyEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49310.6 JobDescTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49510.7 JobProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49710.8 RoleEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50110.9 SkillEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50310.10 SkillProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

11 Learning OData Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50711.1 SAP SuccessFactors Learning Micro Services List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

/curriculum-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509/learningevent-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519user/learningplan-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522/scheduledoffering-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560admin/search-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580user/userassignment-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .592user/userassignment-service/v2 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595user/userlearning-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599admin/user-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .610admin/user-service/v2 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613user/user-service/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625user/user-service/v2 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631catalogSearch/v1 and user/catalogSearch/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643/learningEvent/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654user/itemAssignment/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658admin/userService/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662user/learningPlan/v1 Metadata Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699user/learningHistory/v1 Metadata Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737


Content

admin/searchStudent/v1 and searchStudent/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748user/v1 Metadata Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .755curriculum/v1 and user/curriculum/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792admin/searchItem/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799admin/searchCurriculum/v1 and searchCurriculum/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . .802user/learningEvent/v1 Metadata Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .805admin/financialtransactions/v1 Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809

11.2 Common Use Cases for Learning OData APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811Managing Learning Assignments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811Managing LMS Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854Managing User Enrollment and Attendance Through Web Services. . . . . . . . . . . . . . . . . . . . . . . . .862Finding Learning and Course Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .922Posting Learning Events to the LMS with a Web Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928Purchasing and Approvals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933

11.3 Background Knowledge for Learning Web Service Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955Learning about Entities and their Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955Pagination in SAP SuccessFactors Learning OData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956Include Primary Key in PUT Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .956Search Filter and Operator Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957API Throttling in SAP SuccessFactors Learning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .958Search Criteria for Getting a Single Learning Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958Rules for Choosing the Right ID in SAP SuccessFactors Learning Web Services. . . . . . . . . . . . . . . . 959How Users are Uniquely Identified in SAP SuccessFactors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959Call for Error Codes in SAP SuccessFactors Learning Web Services. . . . . . . . . . . . . . . . . . . . . . . . 960Addition of Optional Fields to Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961Implications of Olingo Library Update from 4.0.0 to 4.2.0 for SAP SuccessFactors Learning. . . . . . . 961

12 Onboarding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96412.1 OnboardingCandidateInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96412.2 HRData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966

ExpandTags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .972FilterFields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976UpdateFields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980

12.3 ODataAuthentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98212.4 OnboardeeAttachment API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983

13 Onboarding MDF Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99413.1 OnboardingEquipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99413.2 OnboardingEquipmentActivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99813.3 OnboardingEquipmentType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100013.4 OnboardingEquipmentTypeValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100313.5 OnboardingGoal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005


13.6 OnboardingGoalActivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100713.7 OnboardingGoalCategory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101013.8 OnboardingMeetingActivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101213.9 OnboardingNewHireActivitiesStep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101413.10 OnboardingProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101713.11 OnboardingMeetingEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019

14 Recruiting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102514.1 Job Application Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025

JobApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1025JobApplicationAssessmentOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050JobApplicationAssessmentReport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053JobApplicationAssessmentReportDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1056JobApplicationComments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1058JobApplicationStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061JobApplicationStatusLabel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063JobApplicationAudit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065JobApplicationSnapshot_Education. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1067JobApplicationSnapshot_OutsideWorkExperience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069JobApplicationOnboardingData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071JobApplicationOnboardingStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072JobApplicationQuestionResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074JobAppTemplate_*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076JobApplicationBackgroundCheckRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076JobApplicationBackgroundCheckResult. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079JobApplicationInterview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081

14.2 Job Requisition Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093JobRequisition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093JobRequisitionFieldControls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1115JobRequisitionLocale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1116JobRequisitionOperator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118JobRequisitionPosting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119JobReqQuestions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121JobReqFwdCandidates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123JobReqScreeningQuestion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1125JobReqScreeningQuestionChoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1127JobReqTemplate_*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128JobAnalyzerReportingData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129Import Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132

14.3 Candidate Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134Candidate and CandidateBackground_*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134CandidateBackground_Education. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144


Content

CandidateBackground_OutsideWorkExperience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146CandidateLight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1148CandidateProfileConversionInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1150CandidateProfileExtension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1153

14.4 Job Offer Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154JobOffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154JobOfferApprover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1164JobOfferTemplate_*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1166OfferLetter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1166RCMAdminReassignOfferApprover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172

14.5 Import Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175inviteToApply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175setSmsNotificationPreference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176getJobReqApprovalActions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177

15 SuccessStoreContent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1178

16 Talent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118116.1 Performance Management Form Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181

FormHeader. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1182FormFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184FormContent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186FormPMReviewContentDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1188FormTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192FormObjective. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1193FormObjectiveDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197FormUserRatingComment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1201FormCompetencySection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204FormCompetency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208FormCustomElement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216FormCustomElementListValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220FormSectionConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1221FormItemConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1223FormIntroductionSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224FormUserInformationSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226FormSummarySection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227FormSignatureSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231FormSignature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234FormRatingScale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235FormRatingScaleValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237FormCompetencyBehavior. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1238FormBehaviorRatingComment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1241


TalentRatings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1244FormPerfPotSummarySection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1248FormObjCompSummarySection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1250FormAuditTrail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258FormReviewFeedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262FormReviewFeedbackList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1266Import Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271

16.2 Workflow Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283FormRouteMap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284FormRouteStep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1285FormRouteSubStep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286

16.3 360 Multirater Form Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1288Form360ReviewContentDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1288Form360RaterSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294Form360Rater. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297FormRaterListSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301FormObjectiveOtherDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303FormObjectiveOtherDetailsItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1306FormObjectiveOtherDetailsItemCol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1311FormObjectiveOtherDetailsItemValueCell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314FormObjectiveComment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318Form360ParticipantCategory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325Form360ParticipantSection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328Form360ParticipantDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336Form360ParticipantColumn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340Form360Participant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343Form360ParticipantConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350

16.4 Succession OData Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356LegacyPositionEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1358NomineeHistory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1362NominationTarget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1367Successor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1374TalentGraphicOption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1376TalentPool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378

16.5 Continuous Performance Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380ContinuousPerformanceUserPermission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380Activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385GoalDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389ActivityFeedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392Achievement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394SupporterFeedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397


Content

GoalAchievements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403GoalAchievementsList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404DevGoalAchievements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406DevGoalAchievementsList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408

16.6 Career Development Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1410DevGoalPlanTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411SimpleDevGoal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413DevGoal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414Function Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422DevLearningCertifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423

16.7 Calibration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425CalibrationTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425CalibrationSession. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431CalibrationSessionSubject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1433CalibrationSubjectRank. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435

16.8 Rewards and Recognition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436SpotAward Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436SpotAwardProgram Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1440SpotAwardProgramAdvancedSettings Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443SpotAwardCategory Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445SpotAwardLevel Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448SpotAwardEligibiltyRule Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1450SpotAwardGuidelineRule Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452SpotAwardBudget Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454

17 Theming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145717.1 ThemeConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145717.2 ThemeTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145817.3 ThemeInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1459


1 What's New in This Guide

This document describes changes to this guide for the recent releases. If you have feedback, please send an email to SAPSuccessFactorsDocumentation@sap.com.

Q2 2018

The following table summarizes changes to this guide for the above release.

What's New Relevant for Data Privacy and Protection

Description More Info

May 18, 2018

Recruiting: Job Application Entity

Role-based permissions to query JobApplicationAssessmentReport

No Updated the Permissions section

JobApplicationAssessmentReport [page 1053]

Initial Publication

Updated the FormHeader entity with formdatastatus value

Yes The formDataStatus is set to '4' when the forms are deleted by the user, or by using the Delete Forms admin tool.

You can view the Performance Management, 360 Degree Multi-rater and Compensation soft deleted forms in information reports by enabling Include Deleted Forms in Role Based Permission.

FormHeader [page 1182]

Talent: Rewards and Recognition


What's New in This Guide



Rewards and Recognition OData APIs

No The following APIs from Rewards and Recognition enable customers to build custom extensions on top of the standard SuccessFactors Rewards and Recognition application.

SpotAward SpotAwardProgram SpotAwardProgramAd

vancedSettings SpotAwardCategory SpotAwardLevel SpotAwardEligibiltiyRule SpotAwardGuidelineRule SpotAwardBudget

Rewards and Recognition [page 1436]

Recruiting: JobOffer

Navigation property for the JobOffer entity

No A new recruitingJobOfferNavnavigation property is now available from the TodoEntryV2 entity.

JobOffer [page 1154]

Q1 2018

The following table summarizes changes to this guide for the above release.



Initial Publication

Matrix Manager Permission update

No matrixReports and matrixManager are managed by the Matrix Manager permission and the Matrix Managed permission is not used for this API

User [page 91]

SAP SuccessFactors HCM Suite OData API: Reference GuideWhat's New in This Guide P U B L I C 11



CandidateProfileConversio-nInfo

Yes To support data privacy and protection compliance in information reporting, you can use this API and the field isAlumni to determine if end users can search for the candidate

CandidateProfileConversio-nInfo [page 1150]

JobRequisitionFieldControls No Lets you access all field permissions defined in the job requisition template for the operator role associated with the login user. This entity holds each field control permission for all the fields defined in the respective job requisition template.

JobRequisitionFieldControls [page 1115]

JobAnalyzserReportingData No Lets a user extract and query data related to what is presented in the RCM Job Analyzer panel of Job Requisitions. This entity contains the job analyzer data and the Job Requisition ID that is used as a key to the parent Job Requisition object. It is used for integration scenarios and offline reporting.

JobAnalyzerReportingData [page 1129]

UserAccount Yes You can use this entity to get information about user accounts including login username, account status, and so on.

UserAccount [page 106]

ToDo No Documentation updated with ToDo category information..

ToDo [page 78]

Audit Data Payloads Yes Describes behavior of OData API audit log payloads when the GDPR switch is active

Audit Log Payloads [page 113]

Photo Yes If your local data privacy and protection compliance requires that you limit access to candidates photos by ensuring that the photo respects RBP.

Photo [page 69]





User No A sample query demonstrating how to retrieve the number of direct reports has been added to the section Use Cases

User [page 91]

March 9, 2018

Recruiting: Job Application entities

JobApplicationStatus No Starting with the Q1 2018 Release, 'jobApplications' that acts as a navigation property from the 'JobApplicationStatus' Odata API entity has been deprecated.

JobApplicationStatus [page 1061]

March 23, 2018


JobApplication No Added the following limitation:

Multi-stage Application is currently not supported in OData API. When inserting a Job Application using OData API, all the required fields need to be passed up-front.

JobApplication [page 1025]

Q4 2017

The following table summarizes changes to this guide for the above release

What's New Description More Info

November 17

Business Rules for API Based File Transfers

Added the following limitation:

When a manager transfer operation is carried out using external system (API calls), the Hide Visibility after Document Transfer setting is not considered, and the Performance forms of all the direct reports will be visible to the old manager.

Business Rules for API Based File Transfers [page 102]



Q4, 2017: Initial Publication

Talent: Performance Management OData API entities

FormPerfPotSummarySection Enables you to fetch the Performance-Potential Summary Section details from the Performance form via OData API.

FormPerfPotSummarySection [page 1248]

FormObjCompSummarySection Enables you to fetch the Objective/Competency Overall Calculation Summary Section (OCOC Section) details which includes overall, adjusted and calculated rating information from the Performance form review section via OData API.

FormObjCompSummarySection [page 1250]

FormAuditTrail You can use this entity to track the form routing details as this entity contains the audit trail information about a Performance Management form.

FormAuditTrail [page 1258]

FormReviewFeedback You can use this entity for extracting Ask for feedback information from a Performance Management form.

FormReviewFeedback [page 1262]

FormReviewFeedbackList You can use this entity for extracting Ask for feedback information list from a Performance Management form.

FormReviewFeedbackList [page 1266]

FormObjectiveOtherDetails You can use this entity to query the extended detail information of form objective.

FormObjectiveOtherDetails [page 1303]

FormObjectiveOtherDetailsItem The FormObjectiveOtherDetailsItem entity is used to query the extended details item information of form objective.

FormObjectiveOtherDetailsItem [page 1306]

FormObjectiveOtherDetailsItemCol The FormObjectiveOtherDetailsItemCol entity is used to query the extended details item column information of form objective.

FormObjectiveOtherDetailsItemCol [page 1311]

FormObjectiveOtherDetailsItemValueCell

The FormObjectiveOtherDetailsItemValueCell entity is used to query the extended details item column information of form objective.

FormObjectiveOtherDetailsItemValueCell [page 1314]

FormObjectiveComment You can use this entity to query the comments information of form objective.

FormObjectiveComment [page 1318]




Form360ParticipantCategory The Form360ParticipantCategory entity is used to query the information of one 360 participant category.

Form360ParticipantCategory [page 1325]

Form360ParticipantSection You can use this entity to get the basic information of 360 participant section and navigate to participants, and participant config.

Form360ParticipantSection [page 1328]

Form360ParticipantDetail You can use this entity to query one column information of 360 participant.

Form360ParticipantDetail [page 1336]

Form360ParticipantColumn You can use this entity to query the basic of 360 participant section and navigate to participant config, participant details.

Form360ParticipantColumn [page 1340]

Form360Participant You can use this entity to query the basic information of 360 participant, and to navigate to participant detail.

Form360Participant [page 1343]

Form360ParticipantConfig You can use this entity to query the basic of 360 participant configuration and to navigate to participant columns and participant categories.

Form360ParticipantConfig [page 1350]

DevLearningCertifications You can use this entity to retrieve the information on career development goal learning activity certifications

DevLearningCertifications [page 1423]

Recruiting: Job Requisition entities

Function Import: getJobReqApprovalActions

You can use this function import to receive approval actions of job requisition that are available on the form, and display the relevant buttons on the mobile devices.

getJobReqApprovalActions [page 1132]


Retrieve different statuses for non-applicant

You can now filter non-applicants by statuses, and they are returned as numerical values such as 1, 2, 3, and so on. These values are mapped to different statuses.


JobApplicationAssessmentOrder A new entity to help meet data privacy and protection compliance and for integrations. It represents the job application order request and its primary business use is to initialize an assessment with a third party provider for internal and external applications.

JobApplicationAssessmentOrder [page 1050]



JobApplicationAssessmentReport A new entity to help meet data privacy and protection compliance and for integrations. It represents the job application assessment report for a candidate in the recruiting module and its primary business use is to check the status of a completed assessment for internal and external applications.

JobApplicationAssessmentReport [page 1053]

JobApplicationAssessmentReportDetail A new entity to help meet data privacy and protection compliance and for integrations. It represents the job application assessment report details and each detail entity represents a report component such as a grade for a candidate.

JobApplicationAssessmentReportDetail [page 1056]

Recruiting: Candidate Entities

Navigation from CandidateLight OData service and Candidate OData service

Updated the navigation properties for Candidate

Candidate and CandidateBackground_* [page 1134]

ToDoEntryV2 is now a Beta API Previously we had stated that ToDo is deprecated and TodoEntryV2 should be used instead. Unfortunately this information was incorrect. ToDoV2 is now Beta and we advise you to keep using ToDo.

ToDo [page 78]

TodoEntryV2 (Beta) [page 87]

Q3 2017

The following table summarizes changes to this guide for the above release



Talent: Performance Management Function Imports

addObjectivesToForm Enables you to add objectives to a Performance form.

addObjectivesToForm [page 1282]

Talent: Continuous Performance Management OData API entities




Added four new APIs in Continuous Performance Management

You now have four new OData API entities in Continuous Performance Management: "GoalAchievements", "GoalAchievementsList", "DevGoalAchievements" and "DevGoalAchievementsList", which enable you to retrieve achievements grouped by performance goals and development goals, respectively. These entities support the Query operation performed on the Achievement entity.

Continuous Performance Management [page 1380]

Three new OData APIs and one Function Import added in Career Development Plan

You now have three new APIs and a function import in Career Development Plan that enable you to query and utilize the development goals.

The new APIs inlcude: DevGoal, DevGoalComment, and DevGoalTask. The DevGoal entity represents the Developmet goal, including all standard fields and customer fields configured in Development goal plan templates. The DevGoalComment and DevGoalTask entities are associated to the DevGoal entity.

The new function import "getDevGoalCompetencies"enables you to retrieve the competencies of a Development goal.

Career Development Plan [page 1410]

Function import for getSPMetadata You can now automate metadata creating for IAS integrations

getSPMetadata [page 112]

ToDo is now deprecated ToDo is deprecated. Please use TodoEntryV2 instead.

ToDo [page 78]

TodoEntryV2 (Beta) [page 87]

Recruiting: Candidate Entities

Function import for SMS preferences You can now enable or disable SMS preferences for candidates

setSmsNotificationPreference [page 1176]

CandidateLight You can now use this entity instead of candidate if you want to speed up validation of mandatory fields.

CandidateLight [page 1148]

CandidateProfileExtension You can use this entity to maintain candidate data that is hidden from the candidate.

CandidateProfileExtension [page 1153]

Candidate* and CandidateBackground Added a note that GET requests cannot have gender column in the expand clause.




Recruiting: Job Offer Entities

Entity for changing the offer approver Available for the new UI, Reassign Offer Approver, you can use this entity to change the offer approver.

RCMAdminReassignOfferApprover [page 1172]

Function Import invitetoApply You can use this function import to change the status of a non-applicant from Forwarded status to Invited to Apply status for a specific job requisition.

inviteToApply [page 1175]

Added a new API call for Job Offer entity

odata/v2/JobApplication(601)?$expand=jobOffer/approvers/offerApproval

Using this, you can get the list of offer approvals for the Job Application with applicationId 601.


Recruiting: Job Application Entities

Retrieve job application in different statuses

You can now filter job application by statuses, and they are returned as numerical values such as 1, 2, 3, and so on. These values are mapped to different statuses.


Added a new entity Job Application Interview

You can use this job entity to generate a list of SuccessFactors HCM users who will interview the applicant.

JobApplicationInterview [page 1081]

Added a note that GET requests cannot have gender column in the expand clause.


Q2 2017

The following table summarizes changes to this guide for the Q2 2017 release


May 12

Talent: Workflow Entities: Import Functions




Updated the sendToNextStep function details

If the current step in the route map is the iterative step, the form can be routed to any user in current Iterative step, provided their UserID is known.

sendToNextStep [page 1273]


General Updates You can now use this guide to access all SF OData API Guides and sections have been reordered on an alphabetical basis for ease of navigation

A link to the Learning OData API reference guide has been added.

CompanyProvisioner Allows you to query which users have access to company provisioning.

CompanyProvisioner [page 50]

Removed Provisioning Settings Removed the Provisioning settings from the following:

1. 360 Multirater Form Entities2. Performance Management Form En

tities3. Succession OData Entities4. Continuous Performance Manage

ment5. Workflow Entities

NoteContact Professional Services, if you need information about Provisioning.

360 Multirater Form Entities [page 1288]

Performance Management Form Entities [page 1181]

Succession OData Entities [page 1356]


Workflow Entities [page 1283]

External Learner Entities (Learning) To capture information about External Learners, the following entities have been created for Learning

ExternalLearner [page 59]

ExternalLearnerAddressInfo [page 62]

ExternalLearnerEmailInfo [page 62]

ExternalLearnerPersonallInfo [page 62]

ExternalLearnerPhoneInfo [page 62]

Function Imports for Common Entities A function import for retrieving smart events metadata definition for externally allowed events.

getExtEventMetaDataDefinition [page 110]

OAuth is now available for accessing customer systems

Oauth offers a more secure alternative than basic authenication.

About HCM Suite OData APIs [page 31]

Talent: Continuous Performance Management



ActivityFeedback The "commenter" field is now a mandatory field, while providing feedback on a Continuous Performance Management Activity using the "ActivityFeedback" OData API.

ActivityFeedback [page 1392]

Talent: Succession

NomineeHistory Available for integration scenarios, the nomination history shows all changes for a successor nomination, per position, including: when a new nominee is added, when the readiness level changes, and when the approval status changes or the nomination comment is changed.

NomineeHistory [page 1362]

Role Based Permissions

RBP OData API DynamicGroup Custom Function

Returns all the permission categories and permissions for the company based on the locale setting.

getPermissionMetadata

Custom Functions [page 131]


Returns all the permissions assigned to the user(s) based on the locale setting.

getUsersPermissions



Returns all the permissions assigned to the role(s) based on the locale setting.

getRolesPermissions


Talent: Performance Management Form Entities

sendToPreviousStep A new send to previous step action is available via OData API. You can now send the form to the previous step, in the modification steps of the Route Map, using OData API.

sendToPreviousStep [page 1275]




FormHeader The following properties have been added to the FormHeader entity:

currentStep stepDueDate sender dateAssigned

The following new navigation property has been added to the FormHeader entity:

formTemplate

FormHeader [page 1182]

Onboarding

OnboardeeAttachment API. A new API has been created in Onboarding that helps you perform functions like, import attachments into the Onboarding panels, update the attachments, review the API response results, and much more.

OnboardeeAttachment API [page 983]

APIs inherent in the MDF based Hiring Manager Activities.

The OData APIs for Furnish Equipment, Goals, and Meetings that are inherent in the MDF based Hiring Manager Activities, are exposed and whitelisted.

OnboardingEquipment [page 994]

OnboardingEquipmentActivity [page 998]

OnboardingEquipmentType [page 1000]

OnboardingEquipmentTypeValue [page 1003]

OnboardingGoal [page 1005]

OnboardingGoalActivity [page 1007]

OnboardingGoalCategory [page 1010]

OnboardingMeetingActivity [page 1012]

OnboardingNewHireActivitiesStep [page 1014]

OnboardingProcess [page 1017]

OnboardingMeetingEvent [page 1019]


Q1 2017



February 10


A new custom function to query permission groups that a specific user belongs to:

getUserRolesReport

Returns formatted XML content that contains all role and group details for the requested user.


EntitySet All SF extensions have now been replaced by SAP extensions. Documentation and sample code has been updated accordingly.

EntitySet [page 35]

AssociationSet [page 36]

NavigationProperty (Deprecated) [page 37]

Metadata Enhancements for UI5 Smart Controls [page 38]

API Center Here you can exercise version control and deep dive into the usage, and performance of your APIs.

January 27

Removed information about StepCompleteHRData API

The StepCompleteHRData API has been deprecated.

N/A

Recruiting APIs Added the following Recruiting OData API entities:

JobApplicationBackgroundCheckRequest

JobApplicationBackgroundCheckResult

JobApplicationBackgroundCheckRequest [page 1076]

JobApplicationBackgroundCheckResult [page 1079]

January 19

Calibration APIs Added the Calibration API OData Entities:

CalbrationTemplate CalibrationSession CalibrationSessionSubject CalibrationSubjectRank

Calibration [page 1425]




Added API entity for createPerformanceReviewForm, under Talent OData APIs

You can use this entity to launch Performance Management Forms automatically based on different work events.

createPerformanceReviewForm [page 1279]

Removed information about Instance Synchronization entities.

These entities are restricted to internal use and are not publicly available.

N/A

Q4 2016



December 22

External User Erroneous sample code removed. ExternalUser [page 63]

December 9

Instance Synchronization entities Added four new entities and one function import for use with Instance Synchronization use cases.

(Removed in Q1 2017 update)

External user entities and function imports

Added information about entities for external users as well as information about the function imports that can be used with them.

ExternalUser [page 63]

ExtAddressInfo [page 68]

ExtEmailInfo [page 68]

ExtPersonalInfo [page 67]

ExtPhoneInfo [page 68]

Function imports related to external user:

getPasswordPolicy [page 110]

getUserNameFormat [page 108]

validateExternalUserPassword [page 109]

validateExternalUserIdAndUsername [page 108]

December 2

Execution Manager entities Added four new entities for use with Execution Manager use cases.

EMEvent [page 151]EMEventAttribute [page 158]EMEventPayload [page 160]EMMonitoredProcess [page 163]

November 4



Added API entity for TalentRatings, under Talent OData APIs

Updated the TalentRatings API entity with use-cases

TalentRatings [page 1244]

Added the SupporterFeedback entity under Talent OData APIs

The SupporterFeedback entity is used to request and provide feedback on CPM Achievements

SupporterFeedback [page 1397]

Added the HRData API under Onboarding.

HRData is an entity that maintains the candidates onboarding information.

HRData [page 966]

Added the ExpandTags medata API under HRData, Onboarding.

This Entity provides the list and fields of all the Data-dictionary that are available in Onboarding.

ExpandTags [page 972]

Added the FiletFields metadata API under HRData, Onboarding

This Entity provides the list of all the Index fields that can be filtered.

FilterFields [page 976]

Added the UpdateFields metadata API under HRData Onboarding.

This Entity provides the list of fields of under HrDataAPIUpdate Data-dictionary.

UpdateFields [page 980]

Added the ODataAuthentication API under Onboarding.

This is an API to authenticate for other OData API calls. This API call is used to get the valid token and this token will be used as authentication in the OData API Calls to fetch the data.

ODataAuthentication [page 982]

Q3 2016



September 30

We've updated the information about the date time format changes announced on May 20th 2016 in the What's New for Changes to Performance Management property types

We've added links to the entities affected by the change to the date property, DateTimeOffSet (FormContent and FormHeader) as well as links to infomation about using the DateTimeOffSet. Please note that only these two entities have been updated.

Take a look at the sample code to see these new properties in the sections FormContent [page 1186] and FormHeader [page 1182]

More information about using this date format is available in Using the DateTimeOffSet Format

September 02



http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_SFAPI_Handbook_en/frameset.htm?ece4eb20a56a48b1848b59cb9985c389.htmlhttp://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_SFAPI_Handbook_en/frameset.htm?ece4eb20a56a48b1848b59cb9985c389.html


Updated field specific changes in Performance Management entities

Enhanced the field specific changes done in Q2 2016. For more information, refer to Table 2 for Performance Management enhancements.


August 5

Updated the SimpleGoal API entity under Goals OData API entities

Updated the SimpleGoal API entity with use-cases

SimpleGoal [page 175]

Added API entities for Continuous Performance Management, under Talent OData APIs

Added the following API entities:

ContinuousPerformanceUserPermission

Activity ActivityFeedback FeedbackFlag ActivityStatus GoalDetail Achievement


RBP OData API DynamicGroup Property A new property in the RBP OData DynamicGroup entity:

staticGroup

DynamicGroup [page 119]


A new custom function to query permission groups that a specific user belongs to:

getDynamicGroupsByUser



A new custom function to query all users that belong to a specific permission group:

getUsersByDynamicGroup


Q2 2016



June 22



RCM OData API Entities Added the Required Fields section to the following entities under RCM OData API Entities:

JobApplication JobRequisition Candidate JobOffer


JobRequisition [page 1093]



RCM OData API Entities Added the following entities under RCM OData API Entities:

JobReqTemplate JobAppTemplate

JobReqTemplate_* [page 1128]

JobAppTemplate_* [page 1076]

June 03

RCM OData API Entities JobApplicationAudit [page 1065]

JobApplicationSnapshot_Education [page 1067]

JobApplicationSnapshot_OutsideWorkExperience [page 1069]

JobApplicationOnboardingData [page 1071]

JobApplicationOnboardingStatus [page 1072]

JobApplicationQuestionResponse [page 1074]

JobReqFwdCandidates [page 1123]

JobReqScreeningQuestion [page 1125]

JobReqScreeningQuestionChoice [page 1127]

CandidateBackground_Education [page 1144]

CandidateBackground_OutsideWorkExperience [page 1146]


JobOfferApprover [page 1164]

JobOfferTemplate_* [page 1166]

OfferLetter [page 1166]




Talent OData API Entities Updated the Permissions section and added a separate section for Provisioning Settings in:

Performance Management Form Entities

Workflow Entities



May 20



Changes to Performance Management property names

The following property names have changed in all relevant Performance Management entities:

objSections is now objectiveSections

compSections is now competencySections

introSection is now introductionSection

userInfoSection is now userInformationSection

custSections in now customSections

sectIndex is now sectionIndex itemConfig is now itemConfigura-

tion sectName is now sectionName sectDesc is now sectionDescription sectWeightKey is now section

WeightKey sectWeight is now sectionWeight sectionConfig is now sectionConfi-

guration minValue is now minimumValue maxValue is now maximumValue textMaxLength is now textMaxi

mumLength elist is now elementListValues usersSysId is now userId id is now fieldId mlts is now metricLookupTables desc is now description longDesc is now longDescription stepDesc is now stepDescription enforceRTECharLimit is now enfor

ceRTECharacterLimit enforcePlainTextCharLimit is now

enforcePlainTextCharacterLimit actionInfo is now actionInformation userInfoElements is now userInfor

mationElements


Changes to Workflow property name stepDesc is now stepDescription See the Workflow section




Changes to Performance Management entity names

The following entity names have changed:

FormUserInfoSection is now FormUserInformationSection

FormSectionConfig is now FormSectionConfiguration

FormItemConfig is now FormItemConfiguration

formRatingScaleEntity is now formRatingScale

formBehaviorRatingScaleEntity is now formBehaviorRatingScale


Changes to Performance Management property (*Date properties)

Data type of following properties is now DateTimeOffset:

Entity: FormContent

Properties: lastModifiedDate

Entity: FormHeader

Properties: formReviewStartDate, formReviewEndDate, formReviewDueDate, formLastModifiedDate, creationDate

Take a look at the sample code to see these new properties in the sections FormContent [page 1186] and FormHeader [page 1182]

More information about using this date format is available in

Q1 2016



Update to User section Explanation that the time to complete the process of refreshing dynamic groups is dependent on group size. Consequently there may be a delay between creating a user and that user being able to login.

User [page 91]



Added the following under Talent OData API Entities:

Performance Management Form Entities.

Workflow Entities. 360 Multirater Form Entities. Succession OData Entities.

These topics provide information on Talent form APIs that are used to enable integration with third party HRIS systems, which allows you to query and update forms.



360 Multirater Form Entities [page 1288]

Succession OData Entities [page 1356]

Reorganized guide Reorganized the guide based on product taxonomy. If you are looking for an entity that was previously documented here but now appears to be missing, please check the Employee Central Guide.

Employee Central Guide.

Q4 2015


What's New Description More Information

Reorganized guide Reorganized the guide based on product taxonomy. DynamicGroup [page 119]

Updated Endpoint URL information

Updated information about data center URLs About HCM Suite OData APIs [page 31]

Updated Goal Entities Some new Goal entities, GoalPlanTemplate and SimpleGoal were added. Others were updated.

See the Goals section

Updated RCM Entities Some new Recruiting entities were added. Others were updated. See the Recruiting Section

Updated To Do API Explanation about the new subjectId tag has been added/ ToDo [page 78]



http://help.sap.com/saphelpiis_cloud4hr/EN/EC_ODataAPI_Ref/frameset.htmhttp://help.sap.com/saphelpiis_cloud4hr/EN/EC_ODataAPI_Ref/frameset.htm

2 About HCM Suite OData APIs

The Open Data Protocol (OData) is a standardized protocol for creating and consuming data APIs. OData builds on core protocols like HTTP, and commonly accepted methodologies like REST. The result is a uniform way to expose full-featured data APIs. OData provides both a standard for how to represent your data and a metadata method to describe the structure of your data, and the operations available in your API. SuccessFactors OData API service is based on OData V2.0.

The HCM Suite OData API is SuccessFactors Web Services API based on OData protocol intended to enable access to data in the SuccessFactors system. The API is data oriented. This API provides methods for CRUD style access (Create, Read, Update and Delete). The API is best used for frequent or real time requests for small amounts of data. Large data requests are better handled by batch FTP processes. This OData API is used to configure entities. Each SuccessFactors module can be accessed using its own set of entities.

Enabling the HCM Suite OData API

The OData API switch in provisioning is set to enabled by default. The OData API feature is available by default, unless you manually turn it off in provisioning.

API Endpoint URLs

Your endpoint URLs for accessing the OData APIs depend on the data center hosting your SuccessFactors instance. Your SuccessFactors support representative can tell you the data center location to use for your instance.

RecommendationWe recommend using OAuth instead of basic authentication for accessing customer systems. Available in scenarios in which the Event Connector is used to integrate Platform systems with a customer system and where the endpoint is a SOAP API.

Below are the URLs for each of the SuccessFactors data centers:

Location Environment Endpoint URL (ODataServiceUrl)

Europe, The Netherlands, Amsterdam

DC2 Production https://api2.successfactors.eu/odata/v2/


DC2 SalesDemo https://apisalesdemo2.successfactors.eu/odata/v2/


DC2 Preview https://api2preview.sapsf.eu/odata/v2/

SAP SuccessFactors HCM Suite OData API: Reference GuideAbout HCM Suite OData APIs P U B L I C 31

Location Environment Endpoint URL (ODataServiceUrl)

USA, Arizona, Chandler DC4 Production https://api4.successfactors.com/odata/v2/

USA, Arizona, Chandler DC4 SalesDemo https://apisalesdemo4.successfactors.com/odata/v2/

USA, Arizona, Chandler DC4 Preview https://api4preview.sapsf.com/odata/v2/

n.a DC5 Production https://api5.successfactors.eu/odata/v2/

USA, Virginia, Ashburn DC8 Production https://api8.successfactors.com/odata/v2/

USA, Virginia, Ashburn DC8 SalesDemo https://apisalesdemo8.successfactors.com/odata/v2/

USA, Virginia, Ashburn DC8 Preview https://api8preview.sapsf.com/odata/v2/

Australia, Sydney DC10 Production https://api10.successfactors.com/odata/v2/

Australia, Sydney DC10 Preview https://api10preview.sapsf.com/odata/v2/

Rot, Germany DC12 Production https://api012.successfactors.eu/odata/v2/

Rot, Germany DC12 Rot https://apirot.successfactors.eu/odata/v2/

Rot, Germany Preview https://api12preview.sapsf.eu/odata/v2/

China, Shanghai DC15 Production https://api15.sapsf.cn/odata/v2/

Germany, Biere DC16 Production https://api16.sapsf.eu/odata/v2/

Canada, Toronto DC17 Preview https://api17preview.sapsf.com/odata/v2/

Canada, Toronto DC 17 Production https://api17.sapsf.com/odata/v2/

Russia, Moscow DC18 Preview https://api18preview.sapsf.com/odata/v2/

Russia, Moscow DC18 Production https://api18.sapsf.com/odata/v2/


About HCM Suite OData APIs

3 Using This Guide

To get the most out of this guide, you will need to use it in conjunction with the OData API Data Dictionary. The data dictionary contains the list of entities available in your SuccessFactors Instance. All the properties and navigation properties for an entity are listed there.

The OData API dictionary also lists the allowed operations, the field (property name), field type and the label. It also tells you which fields are required and which are not. To view the OData dictionary, go to: Admin CenterCompany Settings OData API Data Dictionary .

See the OData Metadata Document [page 34]for more details on the metadata.

SAP SuccessFactors HCM Suite OData API: Reference GuideUsing This Guide P U B L I C 33

4 OData Metadata Document

This section describes the SuccessFactors OData document.

The metadata document is a static resource that describes the data model and type system understood by that particular OData service. You can use the metadata document to learn how to query and navigate between the entities in the system. Metadata extensions provide additional metadata information on the top of AtomPub, which gives you access to advanced operations such as data retrieval filtration. To access the SuccessFactors HCM Suite OData metadata document, go to https:///odata/v2/$metadata. This call supports locale based labels. The default label is "en_US".

The URL will return an XML serialization of the service, including the Entity data model and the service operation descriptions. The metadata response supports only application/atom+xml type. (For example, the metadata response cannot be accessed in JSON).

Cache-Control for OData API $metadata Operations

The value of ETag is used to check if the metadata saved in client cache is the same as the one on the server. The value of max-age in the Cache-Control header is set to the life-cycle of the client metadata cache. If the cache is valid, no new request is sent to the server. When a client raises a request for metadata the first time, the server sends back a response with the latest metadata, along with a response header named ETag. The value of ETag is unique and matches the metadata version. This value is used for If-None-Match in the request header the next time the same request is raised. The server checks the If-None-Match value when a new request arrives. If its value is the same as the latest ETag generated by the server, the server simply sends back a status code of 304 (Not-Modified) instead of resending the entire metadata.

Metadata document and the API

The metadata document describes the capabilities of the API to your SuccessFactors HCM Suite instance. It contains the details of each Entity that is accessible through the API, including fields, their names and labels, their data types, and the relationships (associations) between the Entities.

The metadata document also describes the operations available in the API. The OData protocol specifies four basic data base style operations: Insert, Update, Query and Delete. SuccessFactors has added a fifth operation called Upsert which performs an Insert or Update operations. In the future SuccessFactors may add many other custom operations. Typically custom operations will be perform specific business transactions, especially if a custom API is easier to manage versus a data base style approach against multiple entities.

Development using the metadata document and API

Regardless of which operations are used (create, read, update, delete, upsert, or even custom operations), SuccessFactors HCM Suite will apply the appropriate business logic for each Entity. In other words, even though


OData Metadata Document

the operations appear to be database centric, the API goes through the application business logic layer. The API does not go directly against the database, nor does it bypass the business logic layer. The Entities in the API represent logical application objects familiar to an application user. Note that the Entities do not represent the actual physical data storage implementation, which may be in a different structure.

Using the metadata document for customized development is optional and considered advanced behavior for API clients. It can be critical to API client systems that need to write general code which automatically adjusts to the system configuration. For example, if you are writing a middleware tool that allows runtime discovery of the SuccessFactors HCM OData system, you can use the metadata document to discover the Entities and fields, and their data types.

4.1 EntitySet

The OData Metadata document for SuccessFactors HCM Suite contains the following information about the EntitySet extension.

The EntitySet SF Extension

ATTRIBUTE DEFAULT DESCRIPTION

sap: creatable True Instances of this Entity type can be created.

sap: updatable True Instances of this Entity type can be updated.

sap :upsertable True Instances of this Entity type can be upserted.

sap: deletable True Instances of this entity can be deleted.

Example

Sample Code

SAP SuccessFactors HCM Suite OData API: Reference GuideOData Metadata Document P U B L I C 35

4.2 AssociationSet

The OData Metadata document for SuccessFactors HCM Suite contains the following information about AssociationSet.

The AssociationSet SF Extension

ATTRIBUTE REQUIRED DEFAULT DESCRIPTION

sap:creatable No True Instances of this relation can be created.

sap:updatable No True Instances of this relation can be updated.

sap:upsertable No True Instances of this relation can be upserted.

Example

4.3 Property (Deprecated and Removed)

These attributes have been deprecated since 1511 and have now been removed (1608). This is for information only.

The Property SF Extension

ATTRIBUTE REQUIRED DEFAULT DESCRIPTION COMMENTS

sf:Insertable No True Value of the property can be set by client during insertion; "false if the value is generated by server.

This is equivalent to sap:creatable.

sf:Updatable No True Value of the property can be updated..

This is equivalent to sap:updatable.

sf:Upsertable No True Value of the property can be upserted.

sf:Required No False Indicate the property is required during insertion.


OData Metadata Document


sf:Selectable No True Indicate the property can be used in $select.

sf:Sortable No False Indicate the property can be used in $orderby.

This is equivalent to sap:sortable.

Example

4.4 NavigationProperty (Deprecated)

The OData Metadata document for SuccessFactors HCM Suite contains the following information about the NavigationProperty extension.

NoteThese attributes have been deprecated since 1511 and removed since (1608). This is for information only.

The NavigationProperty SF Extension


sf:Insertable No True Reference of the navigation property can be set by client during insertion; false if the value is generated by server.

sf:Updatable No True Reference of the navigation property can be updated.

sf:Upsertable No True Reference of the navigation property can be upserted .

sf:Required No False Indicate that the property is required during insertion

sf:Selectable No True Indicate that the property can b

SAP SuccessFactors HCM Suite OData API: Reference … · Reference Guide PUBLIC SuccessFactors...

Documents

Transcript of SAP SuccessFactors HCM Suite OData API: Reference … · Reference Guide PUBLIC SuccessFactors...

Leaders Drive Productivity - SAP SuccessFactors HCM ... · • Repetition of performance behavior rather ... Figure 1: The High ... Leaders Drive Productivity SuccessFactors Research

SAP SuccessFactors HCM Cloud Automated Demo · PDF file · 2017-01-06SAP SuccessFactors HCM Cloud Automated Demo Request Tool User Guide ... SAP SUCCESS FACTORS HCM CLOUD OPERATIONS

Integration between SAP ERP HCM and SuccessFactors BizX

SAP SuccessFactors HCM Training - GP Strategies

SAPience.be User Day 13 - Keneos - SAP HCM and SuccessFactors integration

SuccessFactors HCM Suite - SAP Support · SuccessFactors HCM Suite includes: • Employee Central - Deliver real business impact with a next generation core HR system that puts the

Secure data migration from SAP HCM to SAP SuccessFactors · Secure data migration from SAP HCM to SAP SuccessFactors. With low investment and operating costs, unlimited scalability,

SAP SuccessFactors Employee Central OData API: Reference Guide

SAP ERP HCM and SuccessFactors BizX Talent …docshare01.docshare.tips/files/23994/239947205.pdfSAP ERP HCM and SuccessFactors BizX Talent Management Integration Deep dive for Recruiting

SAP Cloud Implementations - sap.lianacms.comsap.lianacms.com/.../hcm-enablement/sap-cloud-implementations.pdf · SAP Cloud Implementations Efficient SuccessFactors Deployments –

SAP SuccessFactors HCM Training - gpstrategies.com€¦ · Ref. Code: SAP SF HCM Training H-Bro 07.09.20.indd SuccessFactors HCM Training Practice Our team consists of highly qualified

INTRODUCING THE SUCCESSFACTORS HCM SUITE - SAP · PDF fileINTRODUCING THE SUCCESSFACTORS HCM SUITE ... retire, many energy ... hire by 66 percent. Attract, engage, and hire great people

How SuccessFactors Employee Central Empowers Core HCM

Lookout Whitepaper SAP SuccessFactors A4 · 2021. 6. 9. · SAP SuccessFactors revolutionized the human capital management (HCM) market, providing everything from core human resources

Secure data migration from SAP HCM to SAP SuccessFactors · 2017-10-03 · Secure data migration from SAP HCM to SAP SuccessFactors. With low investment and operating costs, unlimited

SuccessFactors Learning · SuccessFactors HCM Suite August 2014 Release Document Version: 1.0 - August 22, 2014 SuccessFactors Learning Programs Administration Guide

SAP SuccessFactors.com (HCM) and Oracle E – … SuccessFactors.com (HCM) and Oracle E – Business Suite (ERP) Integration SuccessFactors (SFQL) QueryMore Scenario Bristlecone Whitepaper

SuccessFactors HCM Suite - irp-cdn.multiscreensite.com · SuccessFactors HCM Suite helps HR drive business execution with solutions that are complete, beautiful and flexible enough

Secure data migration from SAP HCM to SAP SuccessFactors

SAP SuccessFactors HCM Cloud Automated Demo … Request...SAP SuccessFactors HCM Cloud Automated Demo Request Tool User Guide v 2.0 September 26, 2016