3 Quick Reference Table – REST API Resource View

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

The following table summarizes the REST resource paths.

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

REST Resource Request More Information
Planning, Oracle Enterprise Planning and Budgeting Cloud    
/HyperionPlanning/rest/ GET Getting REST 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","dpMember":"dpmMemberName"}&offset=10&limit=10 POST List All Planning Units
/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits?q={"scenario":{"scenario"},"version":{"version"},"dpMember":{"dpmMember"}}&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/{applicationName}/planningunits{puhIdentifier}/availableactions GET 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}/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
/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/v1/applicationsnapshots/{applicationSnapshotName}/contents?q={"isFirst":true,"chunkSize":14,"fileSize":"3318004","isLast":false} 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
/interop/rest/{api_version}/services GET Get Information About All Services
/interop/rest/{api_version}/services/{servicename}/recreate GET Run Recreate on a Service
/interop/rest/{api_version}/services/{service_type}/resetservice POST Restart the Service Instance
/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}/migrationq={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/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 Roles
/interop/rest/security/<api_version>/users PUT Remove Users' Role Assignment
/interop/rest/security/users POST Add Users to an Identity Domain
/interop/rest/security/users?filename=<filename> DELETE Remove Users from an Identity Domain
/interop/rest/{api_version}/reports? q={type:userauditreport,fileName:userauditreport.cs v,since=2015-12-10,until=2016-06-10}/interop/rest/{api_version} POST User Audit 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/{api_version}/security/{api_version}/roleassignmentreport POST Role Assignment Report
/interop/rest/v1/services/encryptionkey PUT Set Encryption Key
/interop/rest/v1/services/jobs/777 GET Set Encryption Key
/interop/rest/{api_version}/reports?q={type=provisionreport,fileName=provreport.csv,format=simplified,usertype=serviceusers} POST Set Encryption Key
/armARCS/rest/{version}/jobs POST Adding Users to a Team for Oracle Account Reconciliation Cloud
/armARCS/rest/{version}/jobs POST Removing Users from a Team for Oracle Account Reconciliation Cloud
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Adding Users to a Team for Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs POST Removing Users from a Team for Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud
/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/{api_version}/jobs POST Running Data Rules
/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
Oracle Account Reconciliation Cloud    
/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 Monitor Reconciliations (Reconciliation Compliance)
/armARCS/rest/{version}/jobs POST Run Auto Match (Transaction Matching)
/armARCS/rest/{api_version}/jobs/{job_id} GET Retrieve Job Status for Account Reconciliation
/fcm/rest/fcmapi/{api_version}/report POST Generate Report for Account Reconciliation
Oracle Financial Consolidation and Close Cloud    
/HyperionPlanning/rest/ GET Getting API Versions for Oracle Financial Consolidation and Close Cloud
/fccs/rest/{api_version} GET Get Information about a Specific API Version for Oracle Financial Consolidation and Close Cloud APIs
/HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journal}/actions POST fccs_perform_journal_actions.html#GUID-4546807A-8F36-4BF0-B893-B847D73A6070
/HyperionPlanning/rest/{api_version}/applications/{application}/journalPeriods/{period}/actions POST fccs_perform_journal_update.html#GUID-E63FB5EC-7DB9-4493-9764-BBF84837F2F2
/HyperionPlanning/rest/{api_version}/applications/{application}/journals?q={"scenario","year","period","status"}&offset=0&limit=5 GET fccs_retrieve_journals.html#GUID-83CCE12E-4B05-4686-86C9-62725AA3980C
/HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journal label}?q={"scenario","year","period"}&lineItems=true GET fccs_retrieve_journal_details.html#GUID-36083248-90C1-471C-B2AC-94CBAB18950E
Oracle Profitability and Cost Management Cloud    
/epm/rest/ GET Get API Versions for Oracle Profitability and Cost Management Cloud REST APIs
/epm/rest/{api_version} GET Get Information about a Specific API Version for Oracle Profitability and Cost Management Cloud
/epm/rest/{api_version}/applications/jobs/ChecktaskStatusJob/{processName} GET Retrieve Task Status for Oracle Profitability and Cost Management Cloud
/epm/rest/{api_version}/applications/{application}/jobs/ledgerDeployCubeJob POST Deploy ML Cube
/epm/rest/{api_version}/applications/{application}/jobs/mergeSlices POST Merge Slices for Oracle Profitability and Cost Management Cloud
/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 Oracle Profitability and Cost Management Cloud
/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 Oracle Profitability and Cost Management Cloud
/epm/rest/{api_version}/applications/{application}/templateImportJob POST Import Template for Oracle Profitability and Cost Management Cloud
/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