Describing OData and APIs in Recruiting

The Open Data Protocol (OData) is a standardized protocol for creating and consuming data APIs (application program interface). 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. SAP SuccessFactors OData API service is based on OData V2.0.

The HCM Suite OData API is SAP SuccessFactors Web Services API based on OData protocol intended to enable access to data in the SAP 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 SAP SuccessFactors module can be accessed using its own set of entities.

Clients are very interested in integrating multiple systems together, investing in OData APIs provides a large return on investment for those clients that are willing to build out custom integrations to support their requirements.

There are several areas within Recruiting where OData can be used:

OData API: Job Requisition Entity. This can be used in following cases:

• Build a custom integration to create Requisitions within RCM from 3rd party system
• Build a custom integration to send Requisition information along with attachments to a 3rd party system
• Clients can update Requisitions within RCM from a 3rd party system
• Trigger the "Invite to Apply" feature. This feature will move the candidates from the Forwarded status to the Invite to apply status and send an email to the candidates requesting them to apply to a job requisition

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API: Application Entity

This functionality provide ability to expose the Application entity via OData API for the CREATE and UPDATE operations. This means that clients/Partners can use this API to create/update information about the Application entity. This can be used in following cases:

• Clients can build a custom integration to create Applications within RCM from 3rd party system. (ex: client uses a location specific sourcing method and wants to create candidates and applications in RCM for tracking/reporting/processing purposes)
• Clients can build a custom integration to send Application information along with attachments to a 3rd party system. (ex: client wants to attach offer letters from another system to applications)
• Clients can update Applications within RCM from a 3rd party system
• Clients can query the Applicant Status Audit Trail. Note that only READ operations are supported

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API: Candidate Entity

The Candidate Entity is available via OData API supporting the CREATE, UDPATE, and EXPORT operations. This includes basic candidate data, candidate attachments (resume, CV, and custom attachment fields) and background elements. This can be used in following cases:

• Clients can build a custom integration to create Candidate Profiles within RCM from a 3rd party system
• Clients can build a custom integration to send Candidate information along with attachments and background elements to a 3rd party system
• Clients can update Candidate Profiles using a 3rd party system

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API: Application Entity

This functionality provide ability to expose the Application entity via OData API for the CREATE and UPDATE operations. This means that clients/Partners can use this API to create/update information about the Application entity. This can be used in following cases:

• Clients can build a custom integration to create Applications within RCM from 3rd party system. (ex: client uses a location specific sourcing method and wants to create candidates and applications in RCM for tracking/reporting/processing purposes)
• Clients can build a custom integration to send Application information along with attachments to a 3rd party system. (ex: client wants to attach offer letters from another system to applications)
• Clients can update Applications within RCM from a 3rd party system
• Clients can query the Applicant Status Audit Trail. Note that only READ operations are supported

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API: Application Entity

This functionality provide ability to expose the Application entity via OData API for the CREATE and UPDATE operations. This means that clients/Partners can use this API to create/update information about the Application entity. This can be used in following cases:

• Clients can build a custom integration to create Applications within RCM from 3rd party system. (ex: client uses a location specific sourcing method and wants to create candidates and applications in RCM for tracking/reporting/processing purposes)
• Clients can build a custom integration to send Application information along with attachments to a 3rd party system. (ex: client wants to attach offer letters from another system to applications)
• Clients can update Applications within RCM from a 3rd party system
• Clients can query the Applicant Status Audit Trail. Note that only READ operations are supported

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API: Candidate Entity

The Candidate Entity is available via OData API supporting the CREATE, UDPATE, and EXPORT operations. This includes basic candidate data, candidate attachments (resume, CV, and custom attachment fields) and background elements. This can be used in following cases:

• Clients can build a custom integration to create Candidate Profiles within RCM from a 3rd party system
• Clients can build a custom integration to send Candidate information along with attachments and background elements to a 3rd party system
• Clients can update Candidate Profiles using a 3rd party system

This does not replace SFAPI, and it has no impact to existing integrations with SFAPI. It is a better alternative to SFAPI because it offers more flexibility and functionality.

• OData API access to Prescreening, Offer Approval, Interview Central, etc.

• The following entities are now available via OData API to provide the capability to build custom integrations:

• · Requisition Templates, Application Templates, Offer Template (READ only)
• · These entities are not readable as a regular entity, they are listed on OData API Dictionary, with the template's properties
• · New prescreen entity to allow for easy reporting off application questions and answers (READ)
• · JobReqScreeningQuestion - questions related to a Job Requisition
• · JobReqScreeningQuestionChoice - the possible choices of MULTI_CHOICE and RATING related to a JobReq Question
• · JobApplicationQuestionResponse - the questions' responses

Application - Onboarding Portlet (READ/UPDATE)/ Application - Initiate Onboarding (CREATE)

• JobApplicationOnboardingData - the onboarding portlet of a job application
• JobApplicationOnboardingStatus - the status of a job application onboarding
• initiateOnboarding (function import for initiating onboarding)

Application – Jobs Applied Portlet (READ)

• Implemented as a navigation inside Candidate entity. Can be found as "jobsApplied" inside the Candidate entity.

Interview Central (READ)

• ApplicationInterview - has the information of the interview related to an application
• InterviewOverallAssessment - has the overall ratings and navigation for the individual assessments of an interview
• InterviewIndividualAssessment - has the rating and competency information of an individual assessment of an interview

Offer Approval /UPDATE/CREATE

• Implemented as JobOffer
• Attachments, approvers, versions (READ)

Offer Letter (READ/UPDATE/CREATE)

• Implemented as OfferLetter

sendMailOfferLetter - function import to send an offer letter via email

Clients can build custom integrations using these entities. Some examples are:

• Applicant prescreening question and responses are now available to be exported and analyzed
• Interview Central data is now available to be exported and analyzed

All the Recruiting OData APIs are available in the Integration Center to be able to easily create flat files for consumption and manipulation of data.

Review available materials to learn more about OData: https://community.successfactors.com/t5/API-and-Integration/ct-p/API