The Compound Employee application programming interface (API) for SAP SuccessFactors Employee Central is used to extract employee data out of Employee Central. OData API can return a maximum number of 1000 records in a single page. 2. Here's a list of API servers and mTLS certificate servers for SAP SuccessFactors data centers. The first step is to configure add the URL and the Basic Authentication header. Related Information. 2. Authentication . This guide focuses on OData version 2. 0 + Postman API Client = Perfect Friend. SAP SuccessFactors technology supports the full range of talent processes for your HR professionals, managers, and employees, but can be leveraged to create talent processes to allow you to detect. Query and manage public sector cost object Budget Period. Available Versions: 2H 2023 ; 1H 2023. For example instead of running an Advanced Report on. Use Case 3: Creating a New Picklist Option. Use search and filter to find the corresponding servers for your company. Share. Properties and Navigation Properties. Setup the application. Note. The relationship could be an employment relationship, contingent relationship, pensioner relationship, intern, global assignment. Entity Relation Diagram. clientID = API Key from the registered client in SuccessFactors. The query operation uses the GET HTTP method against a resource URI to retrive data. Reference Link: Permission Settings |. Use Case 2: Update the Self Rating and Comment of an Objective. Please take note and update your bookmarks. . In the Atom format query responses, the ampersand "&" is automatically encoded as "&". For more information on the field-level permissions, refer to Field-level Permissions for Job Applications under the Related Information section of this page. Create a connector configuration using the Admin UI: Select Configure > Connectors and click New Connector. To view the timezone information of an API server, go to your company login page or open your account on the header bar after login, and choose Show version. The templateId is the ID of the Job Requisition template that will be used in creating the requisition. Find key information, best practices, and training for API and Integration. The photoType can be changed according SAP SuccessFactors HCM Suite OData API: Reference Guide on Photo Types subsession from 5. It updates an existing record of hiring data for a candidate. Data Models describe how data elements are structured in a database. userId = User ID used by the registered client in SuccessFactors. Keywords. This article describes the process on how one can access SuccessFactors OData APIs from an ABAP program using the OAuth 2. You are able to change that using the Custom Page Size parameter. This API will return the ID of the current selected Theme in the Theme Manager. Operations . SAP SuccessFactors Employee Central OData API: Reference Guide (Permission Settings Section) 2732680 - USER x ADMIN permission modes - SuccessFactors OData API Permissions; Keywords. 1 About the OData API Reference Guide (V4) The Open Data Protocol (OData) is a standardized protocol for consuming REST APIs. SAP Help Portal Different touch points for API: Login into SuccessFactors and search for API where you can see multiple options ,will discuss briefly on each one of those. Date/Time data types have been reworked to include separate Date, TimeOfDay, Duration, and DateTimeOffset data types. Use Case 2: Create a To-Do Item for User. You may choose to manage your own preferences. SAP SuccessFactors Data Model Reference Guide: Entry Dates and TimeIn Calculation for Job Information; Via the UI you could not manually manipulate these field values or use a rule to set them. Use Case 3: Retrieve Objective Details from FormObjective. If one or more navigated entities are not effective dated, each navigated entities before the first non. You can join multiple options with the "&" character. Related Information. In this section, you'll find the APIs available for Time Off. SAP SuccessFactors Employee Central OData API: Reference Guide. ) To find your SAP SuccessFactors Company ID, in the same dropdown menu, click " Show version information . Entity Relation Diagram. Normal users can only access the forms in their folders. 15. Overview ; API Reference ; Model View ; SAP Cloud SDK ;. The generated IDs are used in the User entity (fields: username and userID ), PerPerson entity (field: personIdExternal, userID. Relationships, a key part of the entity model, are. API Reference; OData V2 Best Practices . Comprises personal and employment details for employees, referred to as Person Objects and Employment Objects in this guide. It's intended to enable access to SAP SuccessFactors data in the system. This entity supports data privacy and protection compliance by making sure that the user account information for a person is available in an OData API. SAP SuccessFactors API Reference Guide (OData V2) Before 1H 2023, API documentation was spread across multiple guides, which could be confusing and time-consuming to navigate. Find APIs to integrate and extend. In OData v4, you can use the PATCH HTTP method to merge records. If the record specified in payload doesn't exist, the server inserts (creates) a new record; if a record exists, the upsert operation updates the record. Enter the following details to generate PGP keys: Name (Key owner name) Email id (Key Owner email id) Key Passphrase (Password) Select Create. This information can be used by integration as needed. SAP SuccessFactors HXM Suite OData API provides methods for create, read, update and delete operations. privateKey = X. API Reference; OData V2 Best Practices . Use Case 1: Query a JobApplicationAssessmentReport. Then, we tested this by making OData API call for getting metadata of this entity using Postman tool and could see this newly added. OData API. Accessing the entities is as simple as knowing the entity name, and then referencing the entity through an HTTP call. Use Case 4: Upsert Job Information of an Employee with Multiple User IDs. These field-level permissions allow Recruiting operators to perform the same action using OData APIs as they perform on the application record in SAP SuccessFactors Recruiting. privacy statement, for purposes that may include site operation, analytics, enhanced user experience, or advertising. In the SF side, the call arrived with OData API upsert in the entity FOCostCenter. 5. These data types make it easy for integration clients to convert date and time values to different time zones as needed. In Integration type, select Background Check. $ openssl req -nodes -x509 -sha256 -newkey rsa:2048 -keyout private. API Center: API Center is centralized reference point for all the configurations related to API. In SAP SuccessFactors, status values are used to identify the different. You can refine query results with filters, sort them in a particular order, page large amount of data, and limit data size by. It has the format: [email protected] document describes the configuration steps to set up recruiting posting in SAP SuccessFactors. Normal users can only access the forms in their folders. SAP SuccessFactors API Reference Guide (OData V2) Favorite. Time Off; WorkSchedule; SAP SuccessFactors API Reference Guide (OData V2) 2H 2023. Supported Operations. This then ensures that under Name, you only see the entities. This article describes the steps on how to perform ODATA API queries and upsert requests via Postman. The common name (CN) represents the hostname of your application. API Integration Platform; Unified. userName = leave it as it is. dtd". The asOfDate parameter retrieves the single records of an entity that is effective on the specified date. Reference Guide PUBLIC. Use Case 3: Upsert a JobApplicationAssessmentReport. Supports single, full, and comma-delimited metadata queries, examples: Supports metadata query on service level only. 02. You can use upsert to batch insert/update and inline-edit records. Changed. This is the unique ID of a user in the Learning Management System (LMS). 0 API, please refer to OData API reference guide: SAP SuccessFactors HXM Suite OData API: Reference Guide. Metadata . 4. Additional Information. Start by gathering all necessary information and documentation related to the subject matter of the reference guide. You can use this function import to send pending offer letters to a candidate. Employee Central comprises of three types of objects: Employee objects contain personal and employment details for employees. Check permission and contact your system administrator to enable permission. Learning now features enhancements to the Learning Plan API to improve the experience for customers and partners in portal situations. List of SAP SuccessFactors API Servers [page 5] 4 PUBLIC SAP SuccessFactors HXM Suite SFAPI: Developer Guide Introduction. The Integration Center enables HR business analysts to build, run, schedule, and monitor simple integrations. We added to the sample code query response to include the new payment category information in benefits MDFs. Parameters. The data could be sensitive. Properties and Navigation Properties. An assignment ID is an identifier assigned to the work relationship between a person and the company. A list of properties in the User entity. The actual rate limit and Retry-After value may vary slightly depending on server conditions. Authenticating from a Browser. SAP Help Portal Click Here to access the SuccessFactors OData API Developer Guide Keywords OData, Developer, Guide, API, Data, Dictionary, O, Entity , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-RCM-API , Webservices & APIs , How To Product SAP SuccessFactors HXM Core all versions SAP SuccessFactors HCM Suite OData API: Developer Guide Here's a list of API servers and mTLS certificate servers for SAP SuccessFactors data centers. read. Restricting Access. Discover and test SuccessFactors APIs and ready to use integration packages on the SAP API Business Hub ( SAP API Business Hub) Use the SAP Integration Suite to build powerful integrations with. Product. Products. In this document, you'll find out how each pagination mechanism. It has the format: [email protected] you choose Atom as the format of your query response and the __next URL contains an ampersand, the link doesn't work because the server doesn't recognize. For example, a user interface can display a field as a label if the field is read only, or display it as an input box if it’s mandatory. You can use the convertAssignmentIdExternal function import to change the assignment ID of a user. Related Information. SAP SuccessFactors Recruiting. These data types make it easy for integration clients to convert date and time values to different time zones as needed. privacy statement, for purposes that may include site operation, analytics, enhanced user experience, or advertising. Reference Guide Learning OData API Reference OData API Reference Content. Furthermore, it also covers known restrictions and limitations. Resolution. Enabling Session Reuse. Int64. read. Step 1: Log on to SuccessFactors as Administrator. Common Entities. Help Portal – SAP SuccessFactors HXM Suite OData API: Reference Guide (V2) Best Practice – JB1. This PerEmail API enables you to read, update, create, or delete an employee's email address. Step 3:Provide the below permissions to the API user. user. 5. Registered client in SuccessFactors Sample File. Choose either Editable or Read Only to allow OData API access to the object: Editable - This option allows you to create and edit object instances through. Integration, Recruiting Management, RCM, ODATA, API, Postman,. Response payload show the data that SF system send to API call source as response from API call (response payload will appear only if you enable the complete payloads. OData V4 Metadata . com. Steps: Choose a service and download the OData metadata file. 4. Description. EC entities time based filters in Integration Center. Table of Contents Table of Contents. The name of your company. Use Case 3: Query a To-Do Item and View its Related Objects. Hub API Reference. Supported Operations. MDF OData. The API uses the generic SFAPI web service endpoints for each data. When you query an effective-dated entity without any date parameters, the result returns a single record effective on the present date. Related Information. Below, XDL API will. You will enter the step 'Exception Configuration'. Since SuccessFactors (SF) is also cloud-based, SAP Analytics Cloud offers connectivity to SuccessFactors as well. SFAPI (SuccessFactors API): SFAPI is a set of web services that provides access to a wide range of HR data within SuccessFactors, allowing for integration with other systems. . CompanyProvisioner Allows you to query which users have access to company provisioning. To make OData API calls to a SAP SuccessFactors company (system), be it demo, test, or production, you need to have an account with the OData Export privilege and this requires access to Admin Center for configuration. Use Case 2: Update the Personal Information of an Employee. See SAP SuccessFactors API Reference Guide (OData V2): Headers. 1. order. API Center . We removed duplicate content about supported elements and attributes and added a link to the reference page. Query form details, including the User Info section, Objective section, Competency section, Summary section, and Signature section in the form. The SAP SuccessFactors HXM Suite OData service supports both Edm. With the id from the above response of the API the next API can be called which is the ThemingConfig API: GET. You can invoke the upsert operation using the. Location for Learning Web Services API Reference Guide. This entity represents the list of to-do items assigned to a user or multiple users. This then ensures that under Name, you only see the entities. Relationships, a key part of the entity model, are. The OData standard provides a '__next' link in your query response if there are more results in the database. This information can be used by integration as needed. Release Notes. Product SAP SuccessFactors HXM Suite all versions This KBA lists out the URLs and external IPs used to connect to the Successfactors API servers located on different. Indicates from which server the response is returned. If the details are available, a process ID is returned. This document will draw upon experiences from implementations and support situations to provide guidance and a reference for customers who are either in the design stages or. Search Scopes: All SAP products; This product;. Use Case 2: Update the Personal Information of an Employee. Use Case 5: Delete a To-Do Item. This can be found in Provisioning > Import/Export Assessment Vendor Packages. Errors, Timeouts, and Access. Properties and Navigation Properties. clientID = API Key from the registered client in SuccessFactors. List of SAP. Note If you use the search capabilities (control F) in Provisioning, the exact text of the setting is listed. To view the timezone information of an API server, go to your company login page or open your account on the header bar after login, and choose Show version information. Login to the Postman to construct the ODATA API call. Enter a Connector Name. A global, cloud-based human resource management software system, evolving to help people and businesses thrive in the experience economy. About SAP SuccessFactors OData APIs (V2) Change History . SAP SuccessFactors Platform; SAP SuccessFactors API Reference Guide (OData V2) API Reference; Learning; SAP SuccessFactors Learning Micro Services List; SAP SuccessFactors API Reference Guide (OData V2) This document. The first guide explains the available OData. DateTimeOffset data types of the OData protocol. Keywords. A link to the Learning OData API reference guide has been added. All standard OData headers are supported. A query in which fromDate equals to toDate is also regarded as a date range query. Access to Career Development Plan: Career Development Planning Career Development Plan (CDP) Access Permission. g. This section contains OData API entities for SAP SuccessFactors Onboarding 1. SAP SuccessFactors Employee Central OData API: Reference Guide Using the Employee Central OData APIs Content SAP SuccessFactors Employee Central OData API: Reference Guide SAP SuccessFactors HCM Suite OData API: Reference Guide API calls to the OData API are made via a HTTP call, which can be triggered from a middleware platform or any other application that supports the OData protocol and can make OData calls. Upsert in OData. With the new combined guides, you have all the information you need in one place. If you can't see it there, check that you have the permission for at least one of the tools hosted on the API Center. Select SuccessFactors Connector - 1. Here, you can restrict API access by users based on a single IP address or IP address range. ODATA LMS API Web Services. The SAP Fieldglass open API framework delivers seamless integrations with major technology solution providers to help customers transform how they engage and manage the external workforce. deactivatedafter: This property filters SAP SuccessFactors inactive users from a particular date on. It's free to sign up and bid on jobs. 0. The API Business Hub is growing every day with new APIs from SAP and our Partners. Product. Get an overview of the onboarding process. Search Scopes: All SAP products;. Employee Central. See SAP SuccessFactors API Reference Guide (OData V2): Headers. General reference guide provides details on the REST API resource and functionality; API access using the OAuth 2. Data Models describe how data elements are structured in a database. The SAP SuccessFactors HXM Suite is an evolved, cloud-based human resources management system (HRMS) with a focus on engagement and experiences. On the new OAuth client registration screen, choose Generate X. Cursor-Based Pagination You can use this feature for the following Employee Central entities:API Servers. Access SFAPI Data Dictionary. Provide the Base Connector Details. Added an API for Learning Administrators to get library details. SAP SuccessFactors Employee Central OData API: Reference Guide; SAP SuccessFactors HCM Suite OData API: Reference Guide; API calls to the OData API are made via a HTTP call, which can be triggered from a middleware platform or any other application that supports the OData protocol and can make OData calls. Use Case 2: Insert a JobApplicationAssessmentReport. Learn how query operations work in SAP SuccessFactors HXM Suite OData API. Choose Add to create a new profile. You can use Time Off to manage absences such as vacation, sick leave, and paid time off. - SAP SuccessFactors HCM Suite. Access the API option profile tool to manage processing parameters for the User entity. 0, api , KBA , LOD-SF-OBX , Onboarding 2. How Does It Work? The effective dating mechanism enables entities to have an effective start date and an effective end date, and a record becomes effective between its start date and end date. The SAP SuccessFactors OData APIs are also available in the SAP SuccessFactors HXM Suite OData API: Reference Guide and the SAP. 0 . Common Name. LMS WEB Services : ODATA 1. 12 as the Connector Type. The column can be removed from the API query. . Use search and filter to find the corresponding servers for your company. The OData API Data Dictionary tool in API Center provides a user-friendly view of OData metadata. When you use this profile in a User API request, you're able to modify the information of an inactive user. Use Case: Updating Hiring Data from External HRIS. Metadata . Possible values are: BizX: Indicates that the response is from an API server. Below XDL API will show results of all the Jobs which are success, failed, running for the tenant Id which you have passed in your payload. Use the ‘Basic Auth’ tab to enter the credentials. A list of role-based permissions required to access API Center tools. If a URL contains characters outside the ASCII set, the characters must be converted into a valid ASCII format. ACTIVE. System query options are query string parameters that can be used to control the order and amount of data returned for the URI. About SAP SuccessFactors OData APIs (V2) OData v2 reference guide. This means the fields/properties that can be found in the Ad Hoc Reports may not necessarily be available in the ODATA API Data Dictionary and vice versa. According to the SFAPI and OData guides, for both the Manager and Custom Manager hierarcies, the individual at the top of the employee hierarchy (e. The communication between OAuth 2. Use case 1: Initiate assessment through JobApplication entity using insert operation. Service Limits . privacy statement, for purposes that may include site operation, analytics, enhanced user experience, or advertising. Search Scopes: All SAP products;. The SAP SuccessFactors OData APIs are also available in the SAP SuccessFactors HXM Suite OData API: Reference Guide and the SAP SuccessFactors HXM Suite OData API: Developer Guide. • The SAP SuccessFactors HXM Suite OData API: Reference Guide (Reference Guide) ODATA Data Model Example Now that we’ve described how ODATA works, let’s look at the ODATA model by diving into the SAP SuccessFactors system. Check Model View. 12 as the Connector Type. 0 protocol; and obtaining and. Represents the customer's company ID. On this page. Build a new Spring application. For such a bridge someone can use again SAP Integration Suite - Cloud Integration or API Management but also a simple application running on. Navigation Property Related Entity Description Permission; UserAccountNav: UserAccount: Navigate to account information, for example, the user name and status of the account. Form OData APIs enable you to: Query a list of form templates. You may choose to manage your own preferences. We updated and added information on the ways to extract user information. Complex types now support inheritance and navigation properties. Use Case 3: Retrieve Objective Details from FormObjective. Query form details, including the User Info section, Objective section, Competency section, Summary section, and Signature section in the form. More details are available in the Implementation Guide “SAP SuccessFactors Data Model Reference Guide”, chapter “Data Model Definitions (DTDs) for SAP SuccessFactors Data Models” Employee Central Master Picklists MDF. We show you what needs to be done (video 4), but this may require the involvement of an administrator. 1H 2022. Date/Time data types have been reworked to include separate Date, TimeOfDay, Duration, and DateTimeOffset data types. Use Case 1: Query the Basic Information of an Objective. Additional Information. These field-level permissions allow Recruiting operators to perform the same action using OData APIs as they perform on the application record in SAP SuccessFactors Recruiting. Date and Time. Where can I find out more about this change and the new SAP SuccessFactors OData entity: PositionRightToReturn? A2. About SFAPI Connectors Caution. SAP SuccessFactors Employee Central serves not only as a system of record for all people- and HR-related data, but also as a platform where everything in the organization comes together to transform the work experience. User Management; User; Use Cases; Querying Different Types of Users; SAP SuccessFactors API Reference Guide (OData V2) 2H 2023. This guide provides an overview of the SFAPI, technical information on how to use the SFAPI, details of the WebIntroduction. (Optional) If you use an XML editor that validates versus a DTD, update row 4 to a value of "sf-form. Supported Operations. You may choose to manage your own preferences. SAP SuccessFactors HXM Suite OData API: Reference Guide. Check the properties set in sap:updatable and sap:upsertable. This will provide you with an access token which can be passed on to the oData API's which will extract the data. Click to go back to the main page LMS ODATA WEBSERVICES KNOWLEDGE SESSION FOR CUSTOMERS, PARTNERS AND SAP PRODUCT SUPPORT 1. userId = User ID used by the registered client in SuccessFactors. On this page. It's free to sign up and bid on jobs. Country/Region-Specific Logic for EmpJob, EmpEmployment, and EmpCompensation. Onboarding. In this guide, you'llOperations. About SAP SuccessFactors OData APIs (V2) Change History . Issued By. Properties and Navigation Properties. Related Information. Onboarding at a Glance. This is part of a larger SAP SuccessFactors HXM Suite – Useful Resources and Documents collection. A link to the Learning OData API reference guide has been added. Step 2: Create an. For individual OData V4 offerings in SAP SuccessFactors, the capabilities vary depending on the implementation of each module. SAP API Business Hub – SAP. An interactive view of the data model can be seen within the ODATA Data Model. The content in this guide has moved. System for Cross-domain Identity Management for Workforce in SuccessFactors. Explore all events in the SAP Business Accelerator Hub. Once done, click on Refresh Headers which adds the Base64 format of header to your request. With sap-successfactors-extensibility service entitled on a BTP sub-account level you can start creating service instances with the api-access plan with Kyma runtime. Use Case 3: Modifying a Position. It assumes that you have configured and authorized a valid SuccessFactors account. API. Step 3: Find out field in SuccessFactors OData API. 0 can be found here: ODATA v2. 360 Multirater Form Entities2. For more information on the field-level permissions, refer to Field-level Permissions for Job Applications under the Related Information section of this page. The hostname or IP address for which the certificate is valid. Describes the MDF OData API behaviors with examples. Successfactors API URLs for different Data Centers. The following Entity Relation Diagram shows the relationship between the different entities. SAP SuccessFactors. 20. Share. You can use this function import to send pending offer letters to a candidate. privateKey = Use the private key you uploaded when you register your client in Successfactors or for this example, we will use the private key we generate from. DateTime and Edm. Permissions . On this page. Use Case 3: Delete an Employee Record. Use Case 2: Update an Email Address. DateTimeOffset data types of the OData protocol. Effective-Dated Entities.