Articles in this section

Available Oracle EPM APIs

When you configure an export, import, or other type of flow step using the prebuilt Oracle EPM connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Oracle EPM API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Account reconciliation APIs

Getting API versions for account reconciliation REST APIs

X

Retrieve periods with a specific status

X

Retrieve job status (reconciliation compliance)

X

Retrieve job status (transaction matching)

X

Retrieve application access level

X

View reconciliation comments

X

Execute a job in account reconciliation

X

Change period status (reconciliation compliance)

X

Create reconciliation (reconciliation compliance)

X

Delete profile

X

Import pre-mapped balances (reconciliation compliance)

X

Import pre-mapped transactions (reconciliation compliance)

X

Import balances (reconciliation compliance)

X

Import profiles (reconciliation compliance)

X

Import rates (reconciliation compliance)

X

Import pre-mapped transactions (transaction matching)

X

Import attribute values

X

Monitor reconciliations (reconciliation compliance)

X

Import reconciliation attributes (reconciliation compliance)

X

Run auto match (transaction matching)

X

Purge transactions (transaction matching)

X

Export application properties

X

Import application properties

X

Export background image

X

Import background image

X

Export logo image

X

Import logo image

X

Working with connections in account reconciliation

X

Set application access level

X

Archive matched transactions (transaction matching)

X

Purge archived transactions (transaction matching)

X

Unmatch matched transactions (transaction matching)

X

Update unmatched transactions (transaction matching)

X

Copy to and from SFTP

Copy to SFTP

X

Copy from SFTP

X

Copy to and from the object store

Copy from object store (v1)

X

Copy from object store (v2)

X

Copy to object store (v1)

X

Copy to object store (v2)

X

Data integration REST APIs

Retrieve job status

X

Lock and unlock POV

X

Running integrations

X

Running a pipeline

X

Import data mapping

X

Export data mapping

X

Export data integration

X

Import data integration

X

Data management REST APIs

Getting API versions for data management APIs

X

Retrieve job status

X

Running data rules in data management

X

Running batch rules

X

Deleting substitution variables

Delete a substitution variable at the plan type level

X

Delete a substitution variable for the application

X

Delete substitution variables at the plan type level

X

Delete substitution variables for the application

X

Enterprise journal REST APIs

Retrieve enterprise journals for financial consolidation and close

X

Retrieve enterprise journal content for financial consolidation and close

X

Retrieve enterprise journal content by year and period for financial consolidation and close

X

Monitor enterprise journals for financial consolidation and close

X

Execute an enterprise journals job

X

Update enterprise journal posting status for financial consolidation and close

X

Update validation status of enterprise journals for financial consolidation and close

X

Enterprise profitability and cost management REST APIs

Getting information about a specific REST API version for enterprise profitability and cost management

X

Clear data by point of view

X

Copy data by point of view

X

Delete point of view

X

Financial consolidation and close REST APIs

Retrieve journals for financial consolidation and close

X

Retrieve journal details for financial consolidation and close

X

Perform journal period updates for financial consolidation and close

X

Export consolidation journals

X

Import consolidation journals

X

Copy data

X

Clear data

X

Validate metadata

X

Generate an intercompany matching report

X

Getting and setting substitution variables

Get all substitution variables defined for the application

X

Get a substitution variable defined for the application

X

Get substitution variables defined at the plan type level

X

Get derived substitution variables at the plan type level

X

Get a substitution variable defined at the plan type level

X

Get a derived substitution variable defined at the plan type level

X

Create or update all substitution variables defined for the application

X

Create and update substitution variables at the plan type level

X

Getting and setting user variable values

Get user variable values defined for the application

X

Get user variable values defined in the application by the user variable name

X

Get user variable values defined in the application by value

X

Get user variable values defined for the application by the user name

X

Get user variable values defined in the application by the user name and value

X

Set the user variable values for the application

X

Import and export files

LCM import (v1)

X

LCM import (v2)

X

LCM export (v1)

X

LCM export (v2)

X

List or restore backups only for OCI gen2 environments

List backups only for OCI (gen 2) environments

X

Manage application snapshots

Get information about all application snapshots

X

Get information about a specific application snapshot

X

Download application snapshot (v1)

X

Upload application snapshot (v1)

X

Upload application snapshot (v2)

X

Download application snapshot (v2)

X

Copy application snapshot (v1)

X

Copy application snapshot (v2)

X

Rename application snapshot (v1)

X

Rename application snapshot (v2)

X

Manage jobs

Get job definitions

X

Retrieve job status

X

Retrieve job status details

X

Retrieve child job status details

X

Execute a job

X

Manage planning units

Get a planning unit owner photo

X

Get planning unit promotional path

X

Get filters with all possible values

X

List all planning units

X

Get planning unit history and annotations

X

Get available planning unit actions

X

Change planning unit status

X

Manage services

Get information about all services

X

Get idle session timeout

X

Set idle session timeout

X

Restart the service instance (v1)

X

Restart the service instance (v2)

X

Run recreate on a service (11.1.2.3.600)

X

Run recreate on a service (v2)

X

Managing users groups and roles

User group report (v2)

X

Role assignment report for users (v2)

X

Role assignment report for groups (v2)

X

Get available roles

X

Add users to an identity domain (v1)

X

Add users to an identity domain (v2)

X

Remove users from an identity domain (v1)

X

Remove users from an identity domain (v2)

X

Assign users to a predefined role or application role (v1)

X

Assign users to a predefined role or application role (v2)

X

Remove users' role assignment (v1)

X

Remove users' role assignment (v2)

X

Add users to a group (v1)

X

Add users to a group (v2)

X

Remove users from a group (v1)

X

Remove users from a group (v2)

X

Update users

X

Add a user to a batch of groups

X

Remove a user from a batch of groups

X

Add groups (v1)

X

Add groups (v2)

X

Remove groups (v1)

X

Remove groups (v2)

X

User group report (v1)

X

User access report (v1)

X

User access report (v2)

X

User audit report (v1)

X

Role assignment report (v1)

X

Role assignment audit report for OCI (gen 2) environments

X

Invalid login report for OCI (gen 2) environments

X

Group assignment audit report

X

Adding users to a team for account reconciliation

X

Adding users to a team for financial consolidation and close and tax reporting

X

Removing users from a team for account reconciliation

X

Removing users from a team for financial consolidation and close and tax reporting

X

Migration API

Clone an environment

X

Copy a file between instances (v1)

X

Copy a file between instances (v2)

X

Provide feedback (v2)

X

Provide feedback (v11.1.2.3.600)

X

Send email (v1)

X

Send email (v2)

X

Skip updates (v1)

X

Skip updates (v2)

X

Profitability and Cost Management REST APIs

Get API versions for profitability and cost management rest APIs

X

Get information about a specific API version for profitability and cost management

X

Generate program documentation report

X

Retrieve task status for profitability and cost management

X

Run ML rule balancing

X

Apply data grants

X

Copy ML POV data

X

Create file-based application

X

Deploy ML cube

X

Enable file-based application

X

Essbase data load for profitability and cost management

X

Export query results

X

Export template for profitability and cost management

X

Generate program documentation report run as a job

X

Import template for profitability and cost management

X

Merge slices for profitability and cost management

X

Optimize aso cube

X

Run ML calculations

X

Run ML clear POV

X

Update dimensions as a job

X

Reporting REST APIs

Retrieve job status for a report

X

Generate report for account reconciliation

X

Generate report for financial consolidation and close and tax reporting

X

Generate user details report for account reconciliation

X

Generate user details report for financial consolidation and close and tax reporting

X

Execute reports for data management

X

Security REST APIs

Get restricted data access

X

Get virus scan on file upload

X

View or update the IP allowlist only for OCI (gen 2) environments

X

Set restricted data access

X

Set virus scan on file upload

X

Manage permission for manual access to database (v1)

X

Manage permission for manual access to database (v2)

X

Set encryption key (v1)

X

Set encryption key (v2)

X

Supplemental data manager REST APIs

Import supplemental collection data for financial consolidation and close

X

Deploy form templates

X

Task manager REST APIs

View all connections

X

Deploy task manager templates

X

Task manager REST APIs

Update task status for event monitoring

X

Tax reporting REST APIs

Copy data

X

Clear data

X

Usage simulation REST APIs

Simulate concurrent usage

X

View and delete files

List files (v11.1.2.3.600)

X

List files (v2)

X

Delete files (v11.1.2.3.600)

X

Delete files (v2)

X

Delete files (v3)

X

Viewing and setting the daily maintenance window time

Get the build version and daily maintenance time (v1)

X

Get the build version and daily maintenance window time (v2)

X

Setting the daily maintenance time (v1)

X

Setting the daily maintenance time (v2)

X

Running daily maintenance while skipping the scheduled daily maintenance (v1)

X

Running daily maintenance while skipping the scheduled daily maintenance (v2)

X

Working with connections

View all connections

X

Working with data slices

Import data slices

X

Export data slices

X

Clear data slices

X

Get Essbase query governor execution time

X

Export essbase data (v2)

X

Essbase block analysis report

X

Set Essbase query governor execution time

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.