4 Quick Reference Table – REST API Resource View

The REST resources provide powerful APIs that you can use to manage Oracle Enterprise Performance Management Cloud as an alternative to using the web-based user interface.

The following table summarizes the REST resource paths.

Table 4-1 Quick Reference Table - REST API Resource View

REST Resource Request More Information
EPM    
/HyperionPlanning/rest/epm/{api_version}/applications/{ application }/connections/{connectionRef} GET View a Connection
/HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections GET View All Connections
/HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections/{connectionRef} GET Update a Connection

Planning, FreeForm, Strategic Workforce Planning, and Sales Planning

   
/HyperionPlanning/rest/ GET Getting API Versions for Planning
/HyperionPlanning/rest/{api_version} GET Get Information about a Specific REST API Version for Planning
/HyperionPlanning/rest/{api_version}/applications/{application}/jobdefinitions GET Get Job Definitions
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs POST Execute a Job
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs/{jobIdentifier} GET Retrieve Job Status
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs/{jobIdentifier}/details GET Retrieve Job Status Details
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs/{jobIdentifier}/childjobs/{childJobIdentifier}/details GET Retrieve Child Job Status Details
/HyperionPlanning/rest/{api_version}/applications/{application}/dimensions/{dimname}/members POST Add Member
/HyperionPlanning/rest/{api_version}/applications/{application}/dimensions/{dimname}/members/{member} GET Get Member
/HyperionPlanning/rest/{api_version}/applications GET Get Applications
/HyperionPlanning/rest/{version}/applications/{application}/planningunits?q={"scenario":"scenarioName","version":"versionName"}}&offset=10&limit=10 POST List All Planning Units
/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits?q={"scenario":{"scenario"},"version":{"version"}}&offset={offset}&limit={limit} GET Get Planning Unit History and Annotations
/HyperionPlanning/rest/{api_version}/applications/{application}/users/{userId}/photo GET Get a Planning Unit Owner Photo
/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puIdentifier}/promotionpath GET Get Planning Unit Promotional Path
/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits{puhIdentifier}/availableactions POST Get Available Planning Unit Actions
/HyperionPlanning/rest/{api_version}/applications/{application}/pufilters GET Get Filters with All Possible Values
/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puhIdentifier}/actions POST Change Planning Unit Status
/HyperionPlanning/rest/{api_version}/applications/{application}/userpreferences GET Get User Preferences
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/importdataslice POST Import Data Slice
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/exportdataslice POST Export Data Slice
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/cleardataslice POST Clear Data Slice
/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables GET Get All Substitution Variables Defined for the Application
/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables/MyPeriod GET Get a Substitution Variable Defined for the Application
/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables POST Create or Update All Substitution Variables Defined for the Application
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables GET Get Substitution Variables Defined at the Plan Type Level
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables?q={"derivedValues":true} GET Get Derived Substitution Variables at the Plan Type Level
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables/CurrYear GET Get a Substitution Variable Defined at the Plan Type Level
HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables/MyPeriod?q={"derivedValues":true} GET Get a Derived Substitution Variable Defined at the Plan Type Level
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables POST Create and Update Substitution Variables at the Plan Type Level
Migration    
/interop/rest/ GET Get REST API Versions for Migration
/interop/rest/{api_version} GET Get Information about a Specific Version of Migration Sample Code
/interop/rest/11.1.2.3.600/applicationsnapshots/{applicationSnapshotName}/contents POST Upload
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/contents GET Download
/interop/rest/{api_version}/applicationsnapshots GET List Files
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName} DELETE Delete Files (v11.1.2.3.600)
/interop/rest/v2/files/delete DELETE Delete Files (v2)
/interop/rest/{api_version}/services GET Get Information About All Services
/interop/rest/{api_version}/services/{servicename}/recreate POST Run Recreate on a Service (11.1.2.3.600)
/interop/rest/v2/config/services/recreate POST Run Recreate on a Service (v2)
/interop/rest/{api_version}/services/{service_type}/resetservice POST Restart the Service Instance (v1)
/interop/rest/v2/config/services/reset POST Restart the Service Instance (v2)
/interop/rest/{api_version}/applicationsnapshots GET Get Information About All Application Snapshots
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName} GET Get Information about a Specific Application Snapshot Sample Code
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/contents?q={"isLast":false,"isFirst": true,"chunkSize":14,"fileSize":55445} POST Upload Application Snapshot
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/content GET Download Application Snapshot
/interop/rest/{api_version}/feedback POST Provide Feedback
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/migrationq={type:"export"} POST LCM Export
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/migration?q={type:"import"} POST LCM Import
/interop/rest/{api_version}/services/dataaccess?accessType={allow|revoke} PUT Manage Permission for Manual Access to Database
/interop/rest/v1/services/copyfile POST Copy a File Between Instances
/interop/rest/v1/services/skipupdate POST Skip Updates
/interop/rest/<api_version>/services/sendmail POST Send Email (v1)
/interop/rest/v2/mails/send POST Send Email (v2)
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/migration?q={type:"import"} POST LCM Import
/interop/rest/{api_version}/services/dailymaintenance GET Get the Build Version and Daily Maintenance Window Time
/interop/rest/{api_version}/services/dailymaintenance?StartTime={N} PUT Setting the Daily Maintenance Window Time
/interop/rest/{api_version}/services/maintenancewindow POST Running Daily Maintenance While Skipping the Scheduled Daily Maintenance
/interop/rest/v1/services/{servicename}/copysnapshot POST Copy Application Snapshot
/interop/rest/v1/renamesnapshot PUT Rename Application Snapshot
/interop/rest/v1/services/copytoobjectstore POST Copy to Object Store (v1)
/interop/rest/v2/objectstorage/copyto POST Copy to Object Store (v2)
/interop/rest/v1/services/copyfromobjectstore POST Copy from Object Store (v1)
/interop/rest/v2/objectstorage/copyfrom POST Copy from Object Store (v2)
/interop/rest/security/<api_version>/users POST Add Users to an Identity Domain
/interop/rest/security/<api_version>/users?filename=<filename> DELETE Remove Users from an Identity Domain
/interop/rest/security/<api_version>/users PUT Assign Users to Predefined or Application Roles
/interop/rest/security/<api_version>/users PUT Remove Users' Role Assignment
/interop/rest/security/<api_version>/users POST Add Users to an Identity Domain
/interop/rest/security/<api_version>/users?filename=<filename> DELETE Remove Users from an Identity Domain
/interop/rest/security/<api_verion>/users PUT Update Users
/interop/rest/{api_version}/reports?q={type:userauditreport,fileName:useraudit report.csv,since:2017-12-10,until:2018-06-10} POST User Audit Report
/interop/rest/security/<api_version>/groups PUT Add a User to a Batch of Groups
/interop/rest/security/<api_version>/groups PUT Remove a User from a Batch of Groups
/interop/rest/security/<api_version>/groups POST Add a Batch of Groups
/interop/rest/security/<api_version>/groups DELETE Remove a Batch of Groups
/interop/rest/security/<api_version>/usergroupreport POST User Group Report
/interop/rest/{api_version}/reports?q={type:provisionreport,fileName:provreport.csv,format:simplified,usertype,serviceusers} POST User Access Report
/interop/rest/security/{api_version}/roleassignmentreport POST Role Assignment Report
/interop/rest/security/{api_version}/roleassignmentauditreport/ POST Role Assignment Audit Report for OCI (Gen 2) Environments
/interop/rest/security/{api_version}/invalidloginreport/ POST Invalid Login Report for OCI (Gen 2) Environments
/interop/rest/epmociservice/v2/ipallowlist GET View the IP Allowlist - Only for OCI (Gen 2) Environments
/interop/rest/epmociservice/v2/ipallowlist POST Update the IP Allowlist - Only for OCI (Gen 2) Environments
/interop/restp{api_version}/reports/groupaudit POST Group Assignment Audit Report
/interop/rest/{api_version}/services/encryptionkey PUT Set Encryption Key
/interop/rest/{api_version}/reports?q={type=provisionreport,fileName=provreport.csv,format=simplified,usertype=serviceusers} POST Set Encryption Key
/interop/rest/security/<api_version>/groups PUT Add a User To a Batch of Groups
/interop/rest/security/<api_version>/groups PUT Remove a User from a Batch of Groups
/interop/rest/v1/services/skipupdate POST Skip Updates
/interop/rest/v1/services/copyfile POST Copy a File Between Instances
/interop/rest/v1/services/clone POST Clone an Environment
/interop/rest/v2/backups/list GET List Backups - Only for OCI (Gen 2) Environments
/interop/rest/v2/backups/restore POST Restore Backup - Only for OCI (Gen 2) Environments
Data Management    
/aif/rest/ GET Get API Versions for Data Management APIs
/aif/rest/{api_version} GET Get Information about a Specific API Version for Data Management APIs
/aif/rest/V1/POV POST Lock and Unlock POV
/aif/rest/{api_version}/jobs POST Running Data Rules
/aif/rest/{api_version}/jobs POST Integration Job Type
/aif/rest/{api_version}/jobs POST Running Batch Rules
/aif/rest/{api_version}/jobs POST Import Data Mapping
/aif/rest/{api_version}/jobs POST Export Data Mapping
/aif/rest/{api_version}/jobs POST Execute Reports for Data Management
/aif/rest/V1/snapshots POST Execute Reports for Data Management
Account Reconciliation    
/armARCS/rest/ GET Get API Versions for Account Reconciliation REST APIs
/armARCS/rest/<api_version> GET Get Information about a Specific API Version for Account Reconciliation REST APIs
/armARCS/rest/{api_version}/jobs POST Execute a Job in Account Reconciliation
/armARCS/rest/{version}/jobs POST Create Reconciliation (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Change Period Status (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Pre-Mapped Transactions (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Profiles (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Rates (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Balances (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Pre-Mapped Balances (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Import Pre-Mapped Transactions (Transaction Matching)
/armARCS/rest/{version}/jobs POST Import Reconciliation Attributes (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Monitor Reconciliations (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Run Auto Match (Transaction Matching)
/armARCS/rest/{version}/jobs POST Adding Users to a Team for Account Reconciliation
/armARCS/rest/{version}/jobs POST Removing Users from a Team for Account Reconciliation
/armARCS/rest/{api_version}/jobs/{job_id} GET Retrieve Job Status for Account Reconciliation
/arm/rest/fcmapi/{api_version}/report POST Generate Report for Account Reconciliation
/arm/rest/fcmapi/{api_version}/rc/export/users POST Generate User Details Report for Financial Consolidation and Close and Tax Reporting
/arm/rest/fcmapi/{api_version}/rc/export/applicationproperties POST Export Application Properties
/arm/rest/fcmapi/{api_version}/rc/import/applicationproperties POST Import Application Properties
/arm/rest/fcmapi/{api_version}/rc/export/backgroundImage POST Export Background Image
/arm/rest/fcmapi/{api_version}/rc/import/backgroundImage POST Import Background Image
/arm/rest/fcmapi/{api_version}/rc/export/logo POST Export Logo Image
/arm/rest/fcmapi/{api_version}/rc/import/logo POST Import Logo Image
Financial Consolidation and Close    
/HyperionPlanning/rest/ GET Getting API Versions for Financial Consolidation and Close
/fccs/rest/{api_version} GET Get Information about a Specific API Version for Financial Consolidation and Close APIs
/HyperionPlanning/rest/cmapi/{api_version}/jobs POST Deploy Task Manager Templates
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Import Supplemental Collection Data for Financial Consolidation and Close
/HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journal}/actions POST Perform Journal Actions for Financial Consolidation and Close
/HyperionPlanning/rest/{api_version}/applications/{application}/journalPeriods/{period}/actions POST Perform Journal Period Updates for Financial Consolidation and Close
/HyperionPlanning/rest/{api_version}/applications/{application}/journals?q={"scenario","year","period","status"}&offset=0&limit=5 GET Retrieve Journals for Financial Consolidation and Close
/HyperionPlanning/rest/ej/{api_version}/jobs POST Execute an Enterprise Journals Job
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs POST Copy Data
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs POST Clear Data
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Deploy Form Templates
/HyperionPlanning/rest/cmapi/{api_version}/updateTasksForEventMonitoring POST Update Task Status for Event Monitoring

/interop/rest/{api_version}/services/dataaccess?accessType={allow|revoke}&disableEmergencyAccess={true|false}

PUT Manage Permission for Manual Access to Database
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Adding Users to a Team for Financial Consolidation and Close and Tax Reporting
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Removing Users from a Team for Financial Consolidation and Close and Tax Reporting
/HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journal label}?q={"scenario","year","period"}&lineItems=true GET Retrieve Journal Details for Financial Consolidation and Close
/HyperionPlanning/rest/ej/v1/ejjournals GET Retrieve Enterprise Journals for Financial Consolidation and Close
/HyperionPlanning/rest/ej/v1/ejjournals/{instanceId} GET Retrieve Enterprise Journal Content for Financial Consolidation and Close
/HyperionPlanning/rest/ej/v1/ejjournalcontent?q={"year","period"} GET Retrieve Enterprise Journal Content by Year and Period for Financial Consolidation and Close
/HyperionPlanning/rest/ej/v1/ejjournals/{instanceId}/poststatus POST Update Enterprise Journal Posting Status for Financial Consolidation and Close
/HyperionPlanning/rest/fcmapi/{api_version}/report POST Generate Report for Financial Consolidation and Close and Tax Reporting
/HyperionPlanning/rest/fcmapi/{api_version}/fcm/export/users POST Generate User Details Report for Financial Consolidation and Close and Tax Reporting
Enterprise Profitability and Cost Management    
/epm/rest/ GET Getting API Versions for Enterprise Profitability and Cost Management
/epm/rest/{api_version} GET Getting Information About a Specific REST API Version for Enterprise Profitability and Cost Management
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ POST Calculate Model
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ POST Clear Data By Point Of View
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ POST Copy Data by Point of View
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ POST Delete Point of View
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ POST Validate Model
Profitability and Cost Management    
/epm/rest/ GET Get API Versions for Profitability and Cost Management REST APIs
/epm/rest/{api_version} GET Get Information about a Specific API Version for Profitability and Cost Management
/epm/rest/{api_version}/applications/jobs/ChecktaskStatusJob/{processName} GET Retrieve Task Status for Profitability and Cost Management
/epm/rest/{api_version}/applications/{application}/jobs/ledgerDeployCubeJob POST Deploy ML Cube
/epm/rest/{api_version}/applications/{application}/jobs/mergeSlices POST Merge Slices for Profitability and Cost Management
/epm/rest/{api_version}/applications/{application}/povs/{povGroupMember}/jobs/runLedgerCalculationJob POST Run ML Calculations
/epm/rest/{api_version}/applications/{application}/povs/{povGroupMember}/jobs/runLedgerCalculationJob POST Run ML Clear POV
/epm/rest/{api_version}/applications/{application}/povs/{srcPOVMemberGroup}/jobs/copyPOVJob/{destPOVMemberGroup} POST Copy ML POV Data
/epm/rest/{api_version}/applications/{application}/povs/{povGroupMember}/jobs/runLedgerCalculationJob POST Run ML Rule Balancing
/epm/rest/{api_version}/applications/{application}/jobs/essbaseDataLoadJob POST Essbase Data Load for Profitability and Cost Management
/epm/rest/v1/fileApplications/{applicationName} POST Create File-Based Application
/epm/rest/{api_version}/fileApplications/{application}/updateDimension POST Update File-Based Application
/epm/rest/{api_version}/fileApplications/{application}/enableApplication POST Enable File-Based Application
/epm/rest/{api_version}/applications/{application}/templateExportJob?fileName={fileName} POST Export Template for Profitability and Cost Management
/epm/rest/{api_version}/applications/{application}/templateImportJob POST Import Template for Profitability and Cost Management
/epm/rest/{api_version}/applications/{application}/exportQueryResultsJob POST Export Query Results
/epm/rest/{api_version}/applications/{application}/jobs/applyDataGrants POST Apply Data Grants
/epm/rest/{api_version}/applications/{application}/povs/{POV}/programDocumentationReport? queryParameter={"fileType":"PDF","useAlias":"true"} GET Generate Program Documentation Report
/epm/rest/{api_version}/applications/<applicationName>/<povName>/jobs/programDocReportJob POST Generate Program Documentation Report - Run as a Job
/epm/rest/v1/applications/{AppName}/jobs/optimizeASOCube POST Optimize ASO Cube