Oracle Cloud EPM Python API Docs | dltHub

Build a Oracle Cloud EPM-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

Oracle Fusion Cloud Enterprise Performance Management (EPM) provides REST APIs for managing, configuring, and interacting with cloud-based performance management applications. The REST API base URL is https://<service_domain> and All requests require authentication via either OAuth 2.0 or HTTP Basic authentication..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Oracle Cloud EPM data in under 10 minutes.


What data can I load from Oracle Cloud EPM?

Here are some of the endpoints you can load from Oracle Cloud EPM:

ResourceEndpointMethodData selectorDescription
applications/HyperionPlanning/rest/v3/applicationsGETitemsGet a list of applications
user_variables/HyperionPlanning/rest/v3/applications/{application}/uservariablesGETitemsGet user variable values
documents/HyperionPlanning/rest/v3/applications/{application}/documentsGETList library documents
journals/HyperionPlanning/rest/v3/applications/{application}/journalsGETitemsRetrieve journals
dimensions/HyperionPlanning/rest/v3/applications/{application}/plantypes/{plantype}/dimensionsGETGet dimensions for a plan type
pufilters/HyperionPlanning/rest/v3/applications/{application}/pufiltersGETitemsGet filters with all possible values

How do I authenticate with the Oracle Cloud EPM API?

All requests require an Authorization header. For Basic authentication, use 'Authorization: Basic <base64_encoded_credentials>'. For OAuth 2, use 'Authorization: Bearer <access_token>'.

1. Get your credentials

Oracle Cloud EPM REST API primarily uses OAuth 2.0 for authentication. The process requires a Cloud EPM Service Administrator to request that a Domain Administrator set up an OAuth 2.0 client in the Identity Domain Cloud Service (IDCS). Once registered, the administrator provides the IDCS URL and Client ID. Users then obtain a refresh token through an interactive process, which is used to generate access tokens (Bearer tokens) for API requests. While Basic Authentication is supported, Oracle explicitly recommends OAuth 2.0 for security. To setup, consult your IDCS administrator to register a confidential application, ensure the 'Refresh token' and 'Device code' grant types are selected, and securely store the resulting Client ID and refresh tokens.

2. Add them to .dlt/secrets.toml

[sources.oracle_cloud_epm_source] access_token = "REPLACE_ME"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv init uv add "dlt[hub]"

1. Install the dlt AI harness:

uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Oracle Cloud EPM API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

uv run python oracle_cloud_epm_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline oracle_cloud_epm_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset oracle_cloud_epm_data The duckdb destination used duckdb:/oracle_cloud_epm.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads /HyperionPlanning/rest/{api_version}/applications/{application}/jobs and /HyperionPlanning/rest/{api_version}/applications/{application}/connections from the Oracle Cloud EPM API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def oracle_cloud_epm_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://<service_domain>", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "user_variables", "endpoint": {"path": "HyperionPlanning/rest/v3/applications/{application}/uservariables", "data_selector": "items"}}, {"name": "journals", "endpoint": {"path": "HyperionPlanning/rest/v3/applications/{application}/journals", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="oracle_cloud_epm_pipeline", destination="duckdb", dataset_name="oracle_cloud_epm_data", ) load_info = pipeline.run(oracle_cloud_epm_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("oracle_cloud_epm_pipeline").dataset() sessions_df = data.user_variables.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM oracle_cloud_epm_data.user_variables LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("oracle_cloud_epm_pipeline").dataset() data.user_variables.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load Oracle Cloud EPM data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-platform — Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for Oracle Cloud EPM?

Request dlt skills, commands, AGENT.md files, and AI-native context.