Oracle HCM API Directory

Oracle Fusion Cloud HCM API Directory

Oracle Fusion Cloud HCM is a cloud-based human resource solution provider which seeks to connect every aspect of the human resources process. It seeks to help enterprises with critical HR functions including, recruiting, training, payroll, compensation, and performance management to drive engagement, productivity, and business value. As a market leader, it allows developers to use Oracle REST APIs to access, view and manage data stored in Oracle Fusion Cloud HCM

Oracle Fusion Cloud HCM API Authorization

Oracle Fusion Cloud HCM API uses authorization to define which users can access the API and relevant information. To get this access, users need to have predefined roles and the necessary security privileges. Oracle’s REST APIs are secured by function and aggregate security privileges, delivered through job roles which are predefined. However, users can also create custom roles to provide access. Authorization and access to Oracle Fusion Cloud HCM API depends on the role of a person and the level of access offered. 

Oracle Fusion Cloud HCM API Objects, Data Models & Endpoints

To get started with Oracle Fusion Cloud HCM API, it is important to understand the end points, data models and objects and make them a part of your vocabulary for seamless access and data management.

Application Management

• POST https://<hostname>.com/odata/v2/upsert : The Update Application Stage API allows users to update the stage of a specific application by providing the application ID and the target stage ID. The request requires an Authorization header with a Bearer token unless accessed through knit. The response includes the status of the update operation, a message indicating success, and the HTTP status code.

Employee Information

• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/absences : The 'Get leave requests of an employee' API retrieves the leave requests for a specific employee. It requires an Authorization header for Basic Authentication unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of leave requests with detailed information such as absence type, status, duration, and associated metadata. The response body contains an array of leave request items, each with attributes like absenceTypeId, approvalStatusCd, startDate, endDate, and more, providing comprehensive details about each leave request.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/benefitEnrollments : This API retrieves the benefit enrollments of a specific employee identified by the personId. It requires an Authorization header for Basic Authentication. The API supports pagination through the offset and limit query parameters. The response includes details such as EnrollmentResultId, PersonId, ProgramId, PlanTypeId, PlanId, OptionId, PersonName, and various dates related to the enrollment coverage. The response also indicates if there are more items to fetch with the hasMore flag.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/documentRecords : The 'Get documents of an employee' API retrieves document records associated with an employee. It requires a Basic Authorization header unless accessed through knit. The API supports query parameters 'offset' and 'limit' to paginate results. The response includes detailed information about each document, such as document type, person details, and creation metadata. The response body contains an array of document records, each with attributes like 'DocumentsOfRecordId', 'DocumentType', 'PersonId', and more. The API also indicates if more records are available with the 'hasMore' flag.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/locations : This API retrieves all locations associated with an employee. It requires an Authorization header for Basic Authentication, unless accessed through knit. The API supports query parameters 'offset' and 'limit' to paginate through the results. The response includes a list of location objects with details such as LocationId, SetId, ActiveStatus, and various flags indicating the type of site. Additional information like address details, effective dates, and creation/update timestamps are also provided.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/salaries : The 'Get compensation information of an employee' API retrieves detailed salary information for a specified employee. The API requires an Authorization header for Basic Authentication, unless accessed through knit. It accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of salary details such as AssignmentId, SalaryId, SalaryAmount, CurrencyCode, and more, along with metadata like count, hasMore, limit, and offset. The API provides comprehensive salary data including frequency, basis, and range details, as well as action and person-related information.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/workers : The 'List all employees' API retrieves a list of employees from the specified server URL. It requires an Authorization header with a Bearer token unless accessed through knit. The API supports optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of employee objects with details such as PersonId, PersonNumber, and metadata like CreatedBy and LastUpdateDate. The response also contains links for navigation and indicates if more employees are available with the 'hasMore' field.
• GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/workers/{{workersUniqID}}/child/nationalIdentifiers : This API retrieves the identification information of an employee using their unique worker ID. The request requires an Authorization header for Basic Auth, unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of national identifiers with details such as NationalIdentifierId, LegislationCode, NationalIdentifierType, and more. The response also indicates if there are more items to fetch with 'hasMore'.
• GET {{base_url}}/workers : The 'List Details of All Employees' API retrieves detailed information about all employees. It requires an Authorization header with Basic authentication credentials. The API supports an optional query parameter 'expand' to specify which related fields to include in the response, such as addresses, emails, legislative information, phones, names, work relationships, and more. The response includes a success flag, a message containing headers and a body with detailed employee information, including personal details, addresses, emails, legislative info, names, national identifiers, phones, photos, and work relationships. The response also includes pagination details like count, hasMore, limit, and offset.

Check out this detailed guide for all endpoints and data models

Oracle Fusion Cloud HCM API Use Cases

• Seamless end-to-end HR process management including, hiring, onboarding, managing, and engaging workforce aligned with global compliances
• Flexible programs to meet specific benefit requirements and the option to calculate and manage benefit plans for each employee group
• Predictive analytics for workflow planning based on risk of leaving, managing team performance and retaining your best performers.
• Advanced reporting helping teams create, manage, and visualize data from Microsoft Excel within Oracle HCM
• Secure, self-service, mobile-responsive options for employees to manage personal data, PTO, payslips, and more

Top customers

12,000+ companies use Oracle Fusion Cloud HCM as their preferred HR tool, including:

• ArcelorMittal S.A., a Luxembourg-based multinational steel manufacturing corporation
• The Deutsche Bahn AG, the national railway company of Germany
• Fujifilm Holdings Corporation, a Japanese company operating in photography, optics, office and medical electronics, biotechnology, and chemicals
• Hormel Foods Corporation, an American food processing company
• Sofigate, a leading business technology transformation company in the Nordics

Oracle Fusion Cloud HCM API FAQs

To better prepare for your integration journey with Oracle Fusion Cloud HCM API, here is a list of FAQs you should go through:

• How to properly paginate in the API for Oracle Fusion Cloud HCM? Answer
• What to do when Oracle Fusion HCM cannot get data from Rest api /workers? Answer
• How to GET Employee Absences data from HCM Fusion by sending two dates in REST API query parameter? Answer
• How to include multiple query parameters in HCM cloud rest Get call? Answer
• How to get Workers by HireDate in Oracle HCM Cloud API? Answer
• How to pull the latest record when there are multiple records with different dates in Oracle HCM? Answer
• How to use SQL Developer with BIPublisher Oracle Cloud HCM? Answer
• How do I get previous data with respect to effective date in Oracle HCM cloud reporting in a separate column? Answer
• What applications that Integrate with Oracle's PeopleSoft Enterprise Human Capital Management? Answer
• Where are Oracle Fusion Assets REST APIs? Answer

How to integrate with Oracle Fusion Cloud HCM API

To integrate with Oracle Fusion Cloud HCM API, ensure that you review the basics and have an understanding of REST APIs. Then get your Fusion Applications Account Info, including username and password. Configure your client, authorize and authenticate and then send an HTTP request and you’re all set to go. For a more detailed understanding of the best practices and a step-by-step guide to integrate with Oracle Fusion Cloud HCM API, check out this comprehensive guide. 

Get started with Oracle Fusion Cloud HCM API

While integrating with Oracle Fusion Cloud HCM API can help businesses seamlessly view, access and manage all HR data, the process of integration can be tricky. Right from building the integration in-house which requires API knowledge, developer bandwidth and much more to managing the integrations, there are several steps in the way. Naturally, the entire integration lifecycle can turn out to be quite expensive as well. Fortunately, companies today can leverage and integrate with a unified HRIS API like Knit, which allows them to connect with multiple HRIS applications, without the need to integrate with each one individually. Connect for a discovery call today to understand how you can connect with Oracle Fusion Cloud HCM API and several other HRIS applications faster and in a cost-effective manner. 

To get started with Knit for Oracle HCM or any other integrations setup a demo here

‍