Skip to main content
oracle-fusion-cloud-hcm icon

Oracle Fusion Cloud HCM (Beta) Connector

SourceAPI DocsQuick StartConnector Changelog

Description​

Oracle Fusion Cloud HCM is a cloud-based human capital management suite that manages the full employee lifecycle, including workers, assignments, departments, jobs, locations, positions, grades, and absences.

Use this component to manage workers, jobs, absences, and other HR data through the Oracle Fusion Cloud HCM REST API.

API Documentation​

This component was built using the Oracle Fusion Cloud HCM REST API (resource version 11.13.18.05).

Connections​

Basic Authentication​

key: basicAuth

To authenticate with Oracle Fusion Cloud HCM using Basic Authentication, an integration user account with REST API access is required. This connection type is suitable for development and testing. For production use, OAuth 2.0 Client Credentials is recommended.

Prerequisites​

  • An Oracle Fusion Cloud HCM instance
  • An integration user account with the Integration Specialist or HCM Integration role granted
  • The instance URL (e.g., https://acme.fa.us2.oraclecloud.com)

Setup Steps​

  1. Log in to Oracle Fusion Cloud HCM as an administrator
  2. Navigate to Tools > Security Console > Users
  3. Create a new user account (or identify an existing one) to act as the integration user
  4. Assign one of the following roles to the user:
    • Integration Specialist
    • HCM Integration
  5. Confirm the user can authenticate against the REST API by issuing a test request against the workers/describe endpoint, as documented in the Oracle HCM REST API Quick Start
  6. Record the Server URL, Username, and Password for the integration user

Configure the Connection​

  • For Server URL, enter the Oracle HCM Cloud instance URL (e.g., https://acme.fa.us2.oraclecloud.com)
  • For Username, enter the Oracle HCM Cloud username of the integration user
  • For Password, enter the password for the integration user account
Security Note

Basic Authentication transmits credentials with every request. Use Basic Authentication only for development or testing. For production, configure the OAuth 2.0 Client Credentials connection instead.

InputNotesExample
Password

The password for the Oracle HCM Cloud user account.

Server URL

The Oracle HCM Cloud instance URL.

https://acme.fa.us2.oraclecloud.com
Username

The Oracle HCM Cloud username with Integration Specialist or HCM Integration Role.

integration.user@example.com

OAuth 2.0 Client Credentials​

key: oauth2ClientCredentials

To authenticate with Oracle Fusion Cloud HCM using OAuth 2.0 Client Credentials, a confidential application must be registered in Oracle Identity Domains (also known as Oracle Identity Cloud Service / IDCS). This connection type is recommended for production use because it issues short-lived access tokens and does not transmit user credentials on every request.

Prerequisites​

  • An Oracle Fusion Cloud HCM instance
  • Administrator access to the associated Oracle Identity Domain (IDCS)
  • The Oracle HCM Cloud instance URL (e.g., https://acme.fa.us2.oraclecloud.com)
  • The Identity Domain base URL (e.g., https://idcs-abc123.identity.oraclecloud.com)

Setup Steps​

  1. Sign in to the Oracle Cloud Console and open the Identity Domain associated with the Oracle HCM Cloud instance
  2. Navigate to Applications > Add > Confidential Application
  3. On the Add Confidential Application page, enter a name (e.g., Oracle HCM Integration) and an optional description, then click Next
  4. Under Client Configuration, select Configure this application as a client now
  5. Under Allowed Grant Types, select Client Credentials
  6. Under Token Issuance Policy, configure access to the Oracle HCM Cloud resource:
    • Select Add Resources, then add the Oracle HCM Cloud application as the protected resource
    • Add the scope required for HCM REST API access (typically urn:opc:resource:fa:instanceid=<id>urn:opc:resource:consumer::all or a similar service-specific scope)
  7. Click Next through the remaining tabs and click Finish
  8. Copy the generated Client ID and Client Secret values (the secret is only shown once)
  9. Click Activate to enable the application
  10. Construct the token URL using the Identity Domain base URL: https://<identity-domain>.identity.oraclecloud.com/oauth2/v1/token
  11. In Oracle Fusion Cloud HCM, ensure the integration user backing the application is granted the Integration Specialist or HCM Integration role so that issued tokens can access HCM REST resources

For more information on creating a confidential application, refer to the Oracle documentation on adding a confidential application. For details on the token endpoint, refer to the OAuth 2.0 token endpoint reference.

Configure the Connection​

  • For Token URL, enter the Identity Domain token endpoint (e.g., https://idcs-abc123.identity.oraclecloud.com/oauth2/v1/token)
  • For Client ID, enter the Client ID from the confidential application
  • For Client Secret, enter the Client Secret from the confidential application
  • For Scopes, leave the default value urn:opc:idm:__myscopes__ to grant access to all assigned Oracle HCM REST API resources, or enter a more restrictive scope that matches the resource configured on the confidential application
  • For Server URL, enter the Oracle HCM Cloud instance URL (e.g., https://acme.fa.us2.oraclecloud.com)
InputNotesExample
Client ID

The Client ID from the confidential application in Oracle Identity Domains.

abc1234567890def1234567890abcdef
Client Secret

The Client Secret from the confidential application in Oracle Identity Domains.

Scopes

The OAuth 2.0 scopes. The default grants access to all Oracle HCM REST API resources.

urn:opc:idm:__myscopes__
Server URL

The Oracle HCM Cloud instance URL.

https://acme.fa.us2.oraclecloud.com
Token URL

The OAuth 2.0 token URL from the Oracle Identity Domain.

https://idcs-abc123.identity.oraclecloud.com/oauth2/v1/token

Triggers​

Atom Feed Notifications​

Checks for new and updated records from a selected Oracle HCM Atom feed on a configured schedule. | key: pollChangesTrigger

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Feed Name

The Oracle HCM Atom feed to subscribe to. Additional feeds can be discovered via the Interface Catalog URL on the Oracle HCM instance.

NewHire
Page Size

The maximum number of Atom feed entries to process per trigger invocation. Oracle HCM caps this at 1000.

100

The Atom Feed Notifications trigger subscribes to an Oracle HCM Atom feed and emits new and updated feed entries on a configured schedule.

Atom feeds are the recommended mechanism for receiving lifecycle events from Oracle Fusion Cloud HCM (such as new hires, employee updates, assignment changes, and terminations) without polling REST resources directly.

How It Works​

  1. Run on the configured schedule (e.g., every 5 minutes)
  2. Request the selected Atom feed using GET /hcmRestApi/atomFeed/{feedName} with an updated-min query parameter set to the timestamp of the last successful poll
  3. Parse the Atom 1.0 XML response into structured entries, including the inner HCM business object payload and the list of changedAttributes
  4. Persist the new poll timestamp to trigger state for use on the next run
  5. Return the parsed entries; if no new entries are found, return an empty array and set polledNoChanges to true

On the first run, the trigger sets the poll timestamp to the current time and returns no entries. Subsequent runs return only entries published or updated after that timestamp.

Event Types​

The trigger supports the following Oracle HCM Atom feeds out of the box:

Feed NameLabelDescription
NewHireNew HireEmitted when a new worker is hired
EmployeeUpdateEmployee UpdateEmitted when an existing worker record is updated
AssignmentAssignmentEmitted when a worker assignment is created or modified
TerminationTerminationEmitted when a worker is terminated

Additional feed names exposed by the Oracle HCM Interface Catalog can be entered manually. Refer to the Oracle HCM Atom feed documentation for the complete list of available feeds.

Returned Data​

The trigger returns all Atom feed entries received since the last poll. When no entries are returned, the trigger sets polledNoChanges to true so downstream steps can short-circuit.

Fields shown are representative. The full response object includes additional properties.

Example payload
{
  "payload": {
    "body": {
      "data": {
        "entries": [
          {
            "id": "Workers-300100099990042-NewHire",
            "feedName": "NewHire",
            "updated": "2026-05-13T09:15:00.000Z",
            "published": "2026-05-13T09:15:00.000Z",
            "changedAttributes": [],
            "content": {
              "Workers": {
                "PersonId": 300100099990042,
                "PersonNumber": "EMP042",
                "FirstName": "Maria",
                "LastName": "Garcia",
                "DisplayName": "Maria Garcia",
                "PrimaryEmailAddress": "maria.garcia@example.com",
                "PrimaryPhoneNumber": "+1-555-0142",
                "HireDate": "2026-05-13",
                "LegalEntityName": "Acme Corporation US LLC",
                "CreationDate": "2026-05-13T09:15:00.000Z",
                "LastUpdateDate": "2026-05-13T09:15:00.000Z"
              }
            }
          },
          {
            "id": "Workers-300100099990042-EmployeeUpdate",
            "feedName": "EmployeeUpdate",
            "updated": "2026-05-13T10:30:00.000Z",
            "published": "2026-05-13T09:15:00.000Z",
            "changedAttributes": [
              "PrimaryPhoneNumber",
              "PrimaryEmailAddress",
              "DisplayName"
            ],
            "content": {
              "Workers": {
                "PersonId": 300100099990042,
                "PersonNumber": "EMP042",
                "FirstName": "Maria",
                "LastName": "Garcia-Lopez",
                "DisplayName": "Maria Garcia-Lopez",
                "PrimaryEmailAddress": "maria.garcia-lopez@example.com",
                "PrimaryPhoneNumber": "+1-555-0199",
                "HireDate": "2026-05-13",
                "LegalEntityName": "Acme Corporation US LLC",
                "CreationDate": "2026-05-13T09:15:00.000Z",
                "LastUpdateDate": "2026-05-13T10:30:00.000Z"
              }
            }
          }
        ]
      }
    }
  },
  "polledNoChanges": false
}
Example Payload for Atom Feed Notifications⤓
Loading…

New and Updated Records​

Checks for new and updated records in a selected Oracle HCM resource type on a configured schedule. | key: pollRecordsTrigger

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Page Size

The maximum number of records to fetch per API page. Multiple pages are fetched automatically until all updated records are retrieved. Oracle HCM caps this at 500.

100
Resource Type

The Oracle HCM data resource to sync. Each trigger instance polls one resource type and emits all records updated since the last run.

Workers

The New and Updated Records trigger checks for new and updated records in a selected Oracle HCM REST resource (Workers, Departments, Jobs, or Locations) based on the LastUpdateDate field on a configured schedule.

This trigger is ideal for bulk data sync scenarios where a full picture of the underlying resource is needed in an external system, complementing the lifecycle-event-oriented Atom Feed Notifications trigger.

For more information on Oracle HCM REST API filtering, refer to the Oracle Fusion Cloud HCM REST API reference.

How It Works​

  1. Run on the configured schedule (e.g., every 5 minutes)
  2. Issue a GET against the selected resource endpoint with the filter q=LastUpdateDate>="<ISO8601>", where the timestamp is the time of the last successful poll
  3. Automatically fetch all matching records by paginating through results until hasMore is false
  4. Persist the new poll timestamp to trigger state for use on the next run
  5. Return the combined list of records along with the resource type; if no records are returned, set polledNoChanges to true

On the first run, the trigger sets the poll timestamp to the current time and returns no records. Subsequent runs return only records updated after that timestamp.

Event Types​

The trigger supports the following Oracle HCM REST resources out of the box:

Resource TypeEndpointDescription
WorkersGET /publicWorkersWorker records (employees, contingent workers)
DepartmentsGET /organizationsDepartment records
JobsGET /jobsJob definitions
LocationsGET /locationsV2Location records

Each supported resource exposes a LastUpdateDate field that enables server-side filtering. Refer to the Oracle Fusion Cloud HCM REST API reference for full resource schemas.

Returned Data​

The trigger returns all records updated since the last poll, along with the resource type that was polled. When no records are returned, the trigger sets polledNoChanges to true so downstream steps can short-circuit.

Fields shown are representative. The full response object includes additional properties.

Example payload
{
  "payload": {
    "body": {
      "data": {
        "records": [
          {
            "PersonId": 300100099990042,
            "PersonNumber": "EMP042",
            "FirstName": "Maria",
            "LastName": "Garcia-Lopez",
            "DisplayName": "Maria Garcia-Lopez",
            "PrimaryEmailAddress": "maria.garcia-lopez@example.com",
            "PrimaryPhoneNumber": "+1-555-0199",
            "DateOfBirth": null,
            "CreationDate": "2026-05-13T09:15:00.000Z",
            "LastUpdateDate": "2026-05-13T10:30:00.000Z"
          }
        ],
        "resourceType": "Workers"
      }
    }
  },
  "polledNoChanges": false
}
Example Payload for New and Updated Records⤓
Loading…

Data Sources​

Select Department​

Select a department from Oracle Fusion Cloud HCM. | key: selectDepartment | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Example Payload for Select Department⤓
Loading…

Select Grade​

Select a compensation grade from Oracle Fusion Cloud HCM. | key: selectGrade | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Example Payload for Select Grade⤓
Loading…

Select Job​

Select a job definition from Oracle Fusion Cloud HCM. | key: selectJob | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Example Payload for Select Job⤓
Loading…

Select Location​

Select a work location from Oracle Fusion Cloud HCM. | key: selectLocation | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Example Payload for Select Location⤓
Loading…

Select Person ID​

Select a worker by Person ID from Oracle Fusion Cloud HCM. | key: selectPersonId | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Use Public Workers

When true, lists from the read-only Public Workers resource. When false, lists from the read/write Workers resource, which requires broader permissions.

false
Example Payload for Select Person ID⤓
Loading…

Select Position​

Select an approved headcount position from Oracle Fusion Cloud HCM. | key: selectPosition | type: picklist

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Example Payload for Select Position⤓
Loading…

Actions​

Create Absence​

Create a new absence entry in Oracle Fusion Cloud HCM. | key: createAbsence

InputNotesExample
Absence Details

Optional absence fields: includes Start Date, End Date, Duration, Unit of Measure, Absence Reason, Absence Status Code, and Comments.

Absence Type ID

The identifier of the absence type (absenceTypeId).

300100000000001
Additional Fields

Any additional request-body fields not covered above, including nested collections (e.g. addresses, attachments). Provided as JSON and merged into the request body.

{
  "addresses": [
    {
      "AddressLine1": "123 Main St"
    }
  ]
}
Connection

The Oracle Fusion Cloud HCM connection to use.

Legal Entity ID

The employer/legal entity the absence is recorded against (legalEntityId).

300100000000002
Person ID

The person the absence belongs to (personId).

100000012345678
Example Payload for Create Absence⤓
Loading…

Create Location​

Create a new work location in Oracle Fusion Cloud HCM. | key: createLocation

InputNotesExample
Additional Fields

Any additional request-body fields not covered above, including nested collections (e.g. addresses, attachments). Provided as JSON and merged into the request body.

{
  "addresses": [
    {
      "AddressLine1": "123 Main St"
    }
  ]
}
Connection

The Oracle Fusion Cloud HCM connection to use.

Description

A description of the location.

Corporate headquarters
Effective End Date

The date the location stops being effective, in YYYY-MM-DD format.

4712-12-31
Effective Start Date

The date the location becomes effective, in YYYY-MM-DD format.

2024-01-01
Email Address

The email address for the location.

nyc-office@example.com
Location Code

Unique code identifying the location within its set.

US-NYC
Location Name

The display name of the location shown to users.

New York Office
Primary Address

Street, city, state, postal code, country, address usage type, effective start and end dates, and location address usage ID.

Set Code

The code of the set the location belongs to.

COMMON
Set ID

The identifier of the set the location belongs to.

300000001
Example Payload for Create Location⤓
Loading…

Create Worker​

Create a new worker record in Oracle Fusion Cloud HCM. | key: createWorker

InputNotesExample
Addresses

The worker's mailing address(es). Add a row per address.

Applicant Number

The applicant number for the worker.

955160008186257
Connection

The Oracle Fusion Cloud HCM connection to use.

Emails

The worker's email address(es). Add a row per email.

First Name

The worker's first name.

Jane
Last Name

The worker's last name. Required by Oracle when creating a worker.

Smith
Legislation Code

The legislation (country) code the name applies to (e.g. US). Required by Oracle when creating a worker.

US
Middle Names

The worker's middle name(s).

Marie
Name Type

The type of name (e.g. GLOBAL). Required by Oracle when creating a worker name.

GLOBAL
National Identifiers

The worker's national identifier(s). Add a row per identifier.

Person Number

The business key for the worker. Leave blank to let Oracle auto-generate it.

100000012345678
Phones

The worker's phone number(s). Add a row per phone.

Title

The worker's title (e.g. Ms., Dr.).

Ms.
Worker Information

Biographical details for the worker.

Work Relationships

The worker's work relationship(s) with a legal employer. Add a row per relationship.

Example Payload for Create Worker⤓
Loading…

Delete Absence​

Delete an absence entry from Oracle Fusion Cloud HCM. | key: deleteAbsence

InputNotesExample
Absence Entry ID

The unique numeric identifier for the Oracle HCM absence entry (AbsenceEntryId).

300100012345678
Connection

The Oracle Fusion Cloud HCM connection to use.

Example Payload for Delete Absence⤓
Loading…

Delete Location​

Delete a work location by Location ID from Oracle Fusion Cloud HCM. | key: deleteLocation

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Location ID

The unique numeric identifier for the Oracle HCM location (LocationId).

300100012345678
Example Payload for Delete Location⤓
Loading…

Get Absence​

Retrieve a single absence entry by Absence Entry ID from Oracle Fusion Cloud HCM. | key: getAbsence

InputNotesExample
Absence Entry ID

The unique numeric identifier for the Oracle HCM absence entry (AbsenceEntryId).

300100012345678
Connection

The Oracle Fusion Cloud HCM connection to use.

Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Example Payload for Get Absence⤓
Loading…

Get Assignment​

Retrieve a single worker assignment by Assignment ID from Oracle Fusion Cloud HCM. | key: getAssignment

InputNotesExample
Assignment ID

The unique numeric identifier for the Oracle HCM assignment (AssignmentId).

300100551559732
Connection

The Oracle Fusion Cloud HCM connection to use.

Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Person ID

The unique numeric identifier for the Oracle HCM worker (PersonId).

100000012345678
Example Payload for Get Assignment⤓
Loading…

Get Department​

Retrieve a single department by Department ID from Oracle Fusion Cloud HCM. | key: getDepartment

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Department ID

The unique numeric identifier for the Oracle HCM department (OrganizationId).

300100012345678
Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Example Payload for Get Department⤓
Loading…

Get Grade​

Retrieve a single compensation grade by Grade ID from Oracle Fusion Cloud HCM. | key: getGrade

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Grade ID

The unique numeric identifier for the Oracle HCM grade (GradeId).

300100012345678
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Example Payload for Get Grade⤓
Loading…

Get Job​

Retrieve a single job definition by Job ID from Oracle Fusion Cloud HCM. | key: getJob

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Job ID

The unique numeric identifier for the Oracle HCM job (JobId).

300100012345678
Example Payload for Get Job⤓
Loading…

Get Location​

Retrieve a single work location by Location ID from Oracle Fusion Cloud HCM. | key: getLocation

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Location ID

The unique numeric identifier for the Oracle HCM location (LocationId).

300100012345678
Example Payload for Get Location⤓
Loading…

Get Position​

Retrieve a single position by Position ID from Oracle Fusion Cloud HCM. | key: getPosition

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Position ID

The unique numeric identifier for the Oracle HCM position (PositionId).

300100012345678
Example Payload for Get Position⤓
Loading…

Get Public Worker​

Retrieve a single worker by Person ID from the read-only Public Workers resource in Oracle Fusion Cloud HCM. | key: getPublicWorker

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Person ID

The unique numeric identifier for the Oracle HCM worker (PersonId).

100000012345678
Example Payload for Get Public Worker⤓
Loading…

Get Worker​

Retrieve a single worker by Person ID from the read/write Workers resource in Oracle Fusion Cloud HCM. | key: getWorker

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Person ID

The unique numeric identifier for the Oracle HCM worker (PersonId).

100000012345678
Example Payload for Get Worker⤓
Loading…

List Absences​

Retrieve a paginated list of absence entries from Oracle Fusion Cloud HCM. | key: listAbsences

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Person ID

Filter absences by Person ID. Omit to retrieve absences across all workers.

100000012345678
Example Payload for List Absences⤓
Loading…

List Assignments​

Retrieve a paginated list of worker assignments. Assignments contain job, department, location, manager, and employment type details. | key: listAssignments

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Person ID

The unique numeric identifier for the Oracle HCM worker (PersonId).

100000012345678
Example Payload for List Assignments⤓
Loading…

List Departments​

Retrieve a paginated list of departments from Oracle Fusion Cloud HCM. | key: listDepartments

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Departments⤓
Loading…

List Grades​

Retrieve a paginated list of compensation grades from Oracle Fusion Cloud HCM. | key: listGrades

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Grades⤓
Loading…

List Jobs​

Retrieve a paginated list of job definitions from Oracle Fusion Cloud HCM. | key: listJobs

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Jobs⤓
Loading…

List Locations​

Retrieve a paginated list of work locations from Oracle Fusion Cloud HCM. | key: listLocations

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Locations⤓
Loading…

List Positions​

Retrieve a paginated list of approved headcount positions from Oracle Fusion Cloud HCM. | key: listPositions

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Positions⤓
Loading…

List Public Workers​

Retrieve a paginated list of workers from the read-only Public Workers resource in Oracle Fusion Cloud HCM. | key: listPublicWorkers

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Public Workers⤓
Loading…

List Workers​

Retrieve a paginated list of workers from the read/write Workers resource in Oracle Fusion Cloud HCM. | key: listWorkers

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Effective Date

Filter results by effective date in YYYY-MM-DD format. Defaults to today if omitted.

2024-01-01
Expand

A comma-separated list of sub-resources to expand inline (e.g., assignments,phones,addresses). Use 'all' to expand all available sub-resources.

assignments
Fetch All

When true, retrieves every page of results and ignores the pagination offset and limit. When false, returns a single page.

false
Include Metadata Links

When true, includes the metadata links (_links) in the response. When false, returns only data fields.

false
Pagination

Offset and limit controls for paging through results.

Example Payload for List Workers⤓
Loading…

Raw Request​

Send a raw HTTP request to Oracle Fusion Cloud HCM REST API. | key: rawRequest

InputNotesExample
Connection

The Oracle Fusion Cloud HCM connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (e.g., /publicWorkers). The base URL (https://{serverUrl}/hcmRestApi/resources/11.13.18.05) is already included.

/publicWorkers
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Raw Request⤓
Loading…

Update Absence​

Update an existing absence entry in Oracle Fusion Cloud HCM. | key: updateAbsence

InputNotesExample
Absence Details

Optional absence fields: includes Start Date, End Date, Duration, Unit of Measure, Absence Reason, Absence Status Code, and Comments.

Absence Entry ID

The unique numeric identifier for the Oracle HCM absence entry (AbsenceEntryId).

300100012345678
Absence Type ID

The identifier of the absence type (absenceTypeId).

300100000000001
Additional Fields

Any additional request-body fields not covered above, including nested collections (e.g. addresses, attachments). Provided as JSON and merged into the request body.

{
  "addresses": [
    {
      "AddressLine1": "123 Main St"
    }
  ]
}
Connection

The Oracle Fusion Cloud HCM connection to use.

Legal Entity ID

The employer/legal entity the absence is recorded against (legalEntityId).

300100000000002
Person ID

The person the absence belongs to (personId).

100000012345678
Example Payload for Update Absence⤓
Loading…

Update Location​

Update an existing work location in Oracle Fusion Cloud HCM. | key: updateLocation

InputNotesExample
Additional Fields

Any additional request-body fields not covered above, including nested collections (e.g. addresses, attachments). Provided as JSON and merged into the request body.

{
  "addresses": [
    {
      "AddressLine1": "123 Main St"
    }
  ]
}
Connection

The Oracle Fusion Cloud HCM connection to use.

Description

A description of the location.

Corporate headquarters
Effective End Date

The date the location stops being effective, in YYYY-MM-DD format.

4712-12-31
Effective Start Date

The date the location becomes effective, in YYYY-MM-DD format.

2024-01-01
Email Address

The email address for the location.

nyc-office@example.com
Location Code

Unique code identifying the location within its set.

US-NYC
Location ID

The unique numeric identifier for the Oracle HCM location (LocationId).

300100012345678
Location Name

The display name of the location shown to users.

New York Office
Primary Address

Street, city, state, postal code, country, address usage type, effective start and end dates, and location address usage ID.

Set Code

The code of the set the location belongs to.

COMMON
Set ID

The identifier of the set the location belongs to.

300000001
Example Payload for Update Location⤓
Loading…

Update Worker​

Update an existing worker record in Oracle Fusion Cloud HCM. | key: updateWorker

InputNotesExample
Addresses

The worker's mailing address(es). Add a row per address.

Applicant Number

The applicant number for the worker.

955160008186257
Connection

The Oracle Fusion Cloud HCM connection to use.

Emails

The worker's email address(es). Add a row per email.

First Name

The worker's first name.

Jane
Last Name

The worker's last name. Required by Oracle when creating a worker.

Smith
Legislation Code

The legislation (country) code the name applies to (e.g. US). Required by Oracle when creating a worker.

US
Middle Names

The worker's middle name(s).

Marie
Name Type

The type of name (e.g. GLOBAL). Required by Oracle when creating a worker name.

GLOBAL
National Identifiers

The worker's national identifier(s). Add a row per identifier.

Person ID

The unique numeric identifier for the Oracle HCM worker (PersonId).

100000012345678
Person Number

The business key for the worker. Leave blank to let Oracle auto-generate it.

100000012345678
Phones

The worker's phone number(s). Add a row per phone.

Title

The worker's title (e.g. Ms., Dr.).

Ms.
Worker Information

Biographical details for the worker.

Work Relationships

The worker's work relationship(s) with a legal employer. Add a row per relationship.

Example Payload for Update Worker⤓
Loading…

Changelog​

2026-08-10​

Initial release of the Oracle Fusion Cloud HCM component with the following capabilities:

  • List Public Workers, Get Public Worker for reading worker records, plus List Workers, Get Worker, Create Worker, Update Worker on the writable Workers resource for managing employee and worker records with individual name fields, worker information, and repeatable addresses, emails, phones, national identifiers, and work relationships
  • List Assignments, Get Assignment for retrieving job, department, location, manager, and employment type details
  • List Departments, Get Department for retrieving organizational units
  • List Jobs, Get Job for retrieving job definitions
  • List Locations, Get Location, Create Location, Update Location, Delete Location for managing work locations via the Locations V2 resource
  • List Positions, Get Position for retrieving approved headcount positions
  • List Grades, Get Grade for retrieving compensation grades
  • List Absences, Get Absence, Create Absence, Update Absence, Delete Absence for managing absence entries
  • Fetch All option on every list action to retrieve all pages of results in a single step
  • Select Job, Select Department, Select Location, Select Grade, Select Position, and Select Person ID data sources for use in config page dropdowns
  • Raw Request for sending arbitrary HTTP requests to the Oracle Fusion Cloud HCM REST API
  • Supports Basic Auth and OAuth 2.0 Client Credentials (via Oracle Identity Domains) authentication