Back

Oracle Cloud HCM API Essential Guide

Aug 3, 20246 minute read

What type of API does Oracle Cloud HCM provide?

Oracle Cloud HCM primarily uses REST APIs. The documentation specifically mentions "About the REST APIs" for Oracle Fusion Cloud HCM. There is no mention of GraphQL or SOAP APIs being used for Oracle Cloud HCM in the provided search results.

Does the Oracle Cloud HCM API have webhooks?

The search results do not contain any specific information about the Oracle Cloud HCM API or its webhook capabilities. The provided information primarily focuses on webhooks in Oracle Content Management and Oracle Developer Cloud Service. Therefore, I cannot definitively state whether the official Oracle Cloud HCM API has webhooks or what events you can subscribe to.

However, I can provide some general information about webhooks in Oracle cloud services based on the search results:

Key Points to Consider:

  1. Oracle cloud services often provide webhook functionality for various purposes, such as receiving notifications about events or pushing notifications to external applications.

  2. Webhooks in Oracle services typically allow users to subscribe to specific events and receive notifications when those events occur.

  3. The configuration of webhooks usually involves specifying a target URL (endpoint) where notifications will be sent, along with authentication settings if required.

Examples of Webhook Usage in Oracle Services:

While not specific to Oracle Cloud HCM, here are some examples of webhook usage in other Oracle cloud services:

  1. Oracle Content Management uses webhooks for:

    • Asset lifecycle events
    • Asset publishing events
    • Site publishing events
    • Prerendering events
    • Scheduled jobs events
  2. Oracle Developer Cloud Service uses webhooks for:

    • Sending event notifications to Oracle Social Network conversations
    • Notifying external services about events like Git pushes, issue updates, merge request updates, and build completions

Best Practices:

  1. When configuring webhooks, ensure you have the necessary permissions (e.g., project Owner role).

  2. Choose between brief and detailed payload options when available to control the amount of information sent in notifications.

  3. Implement proper authentication mechanisms for webhook endpoints to ensure security.

  4. Monitor webhook events using event logs provided by the service.

In conclusion, while I cannot provide specific information about webhooks in the Oracle Cloud HCM API, it's possible that similar webhook functionality exists. To get accurate information about the Oracle Cloud HCM API's webhook capabilities, I recommend consulting the official Oracle Cloud HCM API documentation or contacting Oracle support directly.

Rate Limits and other limitations

Based on the search results provided, I can summarize the API rate limits for Oracle Cloud HCM API as follows:

General API Rate Limits

Oracle APIs are subject to rate limiting to protect the API service usage for all Oracle's customers. The rate limits vary depending on the identity domain type and the specific API group.

Rate Limits for Different Identity Domain Types

The rate limits are categorized into different API groups and vary based on the identity domain type (Free, Oracle Apps, Oracle Apps Premium, Premium, and External User). Here are some examples:

  • AuthN API Group:

    • Per second: 10 (Free) to 95 (Premium)
    • Per minute: 150 (Free) to 4500 (Premium)
  • Token Management API Group:

    • Per second: 10 (Free) to 65 (Premium)
    • Per minute: 150 (Free) to 3400 (Premium)
  • Other API Groups:

    • Per second: 20 (Free) to 90 (Premium)
    • Per minute: 150 (Free) to 5000 (Premium)
  • Bulk API Group:

    • Per second: 5 (all tiers)
    • Per minute: 200 (all tiers)

Other Restrictions

There are additional restrictions for Bulk, Import, and Export operations:

  • Payload size: 1 MB
  • Bulk API: 50 operations limit per call
  • CSV Import: 100K rows limit per CSV & Max file size: 10 MB
  • CSV Export: 100K rows limit

Oracle CRM On Demand REST API

For Oracle CRM On Demand's REST API, the request rate limit is 30 requests per minute.

Oracle API Platform Cloud

In the Oracle API Platform Cloud, you can set custom rate limits for plans. These rate limits apply across all entitlements and can have multiple conditions.

Oracle Integration Generation 2

For Oracle Integration Generation 2, there are various service limits for different resources. Some relevant limits include:

  • Maximum payload size in REST APIs:

    • 10 MB for content-type headers containing JSON, XML, HTML, YAML, or YML
    • 20 MB for other content types
  • Active integrations limit: 700

  • Synchronous integration message timeout: 300 seconds

It's important to note that these limits may vary depending on the specific Oracle Cloud service and tier you are using. Always refer to the most up-to-date documentation for your specific service and subscription level.

Latest API Version

Based on the search results provided, here are the key points regarding the most recent version of the Oracle Cloud HCM API:

  1. The most recent version mentioned is Oracle Human Resources 24A [2].

  2. The latest documentation for the REST APIs is dated August 2024 [1].

  3. The REST APIs allow users to view and manage data stored in Oracle Fusion Cloud HCM [1][3].

  4. The documentation includes:

    • A quick start guide with a simple request example
    • Use cases with real-world solutions and code examples
    • Detailed descriptions for each REST resource [1][3]
  5. Oracle releases updates in two forms:

    • Release Updates (e.g. 21A, 21B, 21C, 21D)
    • Optional Monthly Maintenance Packs for each update [4]
  6. It's important to know which Release Update your environment is on, which can be found in the Cloud Portal [4].

  7. Oracle publishes Known Issues documents and Maintenance Pack documentation for each update to inform customers of potential problems and bug fixes [4].

While the search results don't explicitly state a single "most recent version" of the API, they indicate that Oracle Human Resources 24A is the latest documented version, with REST API documentation last updated in August 2024. It's important to note that Oracle regularly updates its cloud services, so checking the official Oracle documentation for the most up-to-date information is always recommended.

How to get a Oracle Cloud HCM developer account and API Keys?

To get a developer account for Oracle Cloud HCM to create an API integration, you need to follow these key steps:

Subscribe to Oracle HCM Cloud

  1. Subscribe to Oracle HCM Cloud. This allows you to create an Oracle HCM Cloud user account with the correct privileges.

Assign Required Roles

  1. Assign the following required roles to the integration user:
  • ORA_HRC_HUMAN_CAPITAL_MANAGEMENT_INTEGRATION_SPECIALIST_JOB (for Releases 12 and 13)
  • AttachmentsUser
  • SOAOperator
  • FND_MANAGE_CATALOG_SERVICE_PRIV

Request API Access

  1. Request access to Atom feeds and REST APIs capabilities on your Oracle HCM Cloud instances. This needs to be enabled specifically for your HCM Cloud application.

Create Connection in Oracle Integration

  1. Create a connection to Oracle HCM Cloud in Oracle Integration:
  • Configure the connection properties
  • Configure the connection security (username/password or OAuth)
  • Test the connection

Key Points to Consider

  • You may need to upload an SSL certificate for the connection.
  • For OAuth authentication, you'll need to perform additional prerequisites like creating an OAuth client in Oracle HCM Cloud.
  • Verify if Location-Based Access Control (LBAC) is enabled, as you may need to allowlist the Oracle Integration IP addresses.

Best Practices

  • Use a dedicated integration user account rather than a personal account.
  • Follow the principle of least privilege when assigning roles.
  • Properly secure and rotate any credentials or certificates used for the integration.

By following these steps, you'll be able to set up a developer account and create the necessary API integration between Oracle Integration and Oracle HCM Cloud. The exact details may vary slightly based on your specific Oracle HCM Cloud version and setup.

What can you do with the Oracle Cloud HCM API?

Based on the search results provided, here is a summary of the data models that can be interacted with using the Oracle Cloud HCM API, along with what is possible for each:

Core HCM Data Models

  • Employees

    • View and manage employee data
    • Create, update, and terminate employees
    • Retrieve employee details
  • Jobs

    • View and manage job data
    • Create and update job definitions
    • Retrieve job details
  • Departments

    • View and manage department data
    • Create and update department structures
    • Retrieve department details
  • Locations

    • View and manage location data
    • Create and update location information
    • Retrieve location details

Talent Management Data Models

  • Positions

    • View and manage position data
    • Create and update position definitions
    • Retrieve position details
  • Grades

    • View and manage grade data
    • Create and update grade structures
    • Retrieve grade details

Workforce Management Data Models

  • Time and Labor

    • View and manage time entry data
    • Create and update timecards
    • Retrieve time and attendance information
  • Absence Management

    • View and manage absence data
    • Create and update absence records
    • Retrieve absence details

Additional Data Models

  • Users

    • View and manage user data
    • Create and update user accounts
    • Retrieve user details
  • Business Units

    • View and manage business unit data
    • Create and update business unit structures
    • Retrieve business unit details
  • Legal Employers

    • View and manage legal employer data
    • Create and update legal employer information
    • Retrieve legal employer details

For each of these data models, the Oracle Cloud HCM API generally allows you to perform CRUD (Create, Read, Update, Delete) operations, as well as retrieve detailed information and perform specific actions related to each entity. The API provides a flexible and powerful way to integrate with and manage data in Oracle HCM Cloud.

It's important to note that the specific operations and capabilities may vary depending on the particular API endpoint and your access permissions. Always refer to the official Oracle HCM Cloud API documentation for the most up-to-date and detailed information on available operations for each data model.