6 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.
These tables summarize the REST resource paths.
- EPM Platform
- Planning, FreeForm, Strategic Workforce Planning, and Sales Planning
- Migration
- Daily Maintenance Window Time
- Managing Users
- Usage Simulation REST APIs
- Reporting REST APIs
- Data Integration REST APIs
- Data Management REST APIs
- Account Reconciliation
- Financial Consolidation and Close
- Task Manager
- Supplemental Data Manager
- Enterprise Journals
- Tax Reporting
- Enterprise Profitability and Cost Management
- Profitability and Cost Management
EPM Platform
Table 6-1 EPM Platform
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Execute a Report Bursting Definition |
/HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections/{connectionRef} |
GET | Update a Connection |
/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 |
Planning, FreeForm, Strategic Workforce Planning, and Sales Planning
Table 6-2 Planning, FreeForm, Strategic Workforce Planning, and Sales Planning
| Rest Resource | Request | More Information |
|---|---|---|
/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 |
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables/subvarname |
DELETE | Delete a Substitution Variable at the Plan Type Level |
/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables/subvarname |
DELETE | Delete a Substitution Variable for the Application |
/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables:delete |
POST | Delete Substitution Variables at the Plan Type Level |
/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables:delete |
POST | Delete Substitution Variables for the Application |
Migration
Table 6-3 Migration
| Rest Resource | Request | More Information |
|---|---|---|
| Getting REST API Versions for 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 |
| Import and Export Files | ||
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/migration?q={type:"import"} |
POST | LCM Import (v1) |
/interop/rest/v2/snapshots/import |
POST | LCM Import (v2) |
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/migrationq={type:"export"}
|
POST | LCM Export (v1) |
/interop/rest/v2/snapshots/export |
POST | LCM Export (v2) |
| Upload and Download Files | ||
/interop/rest/11.1.2.3.600/applicationsnapshots/{applicationSnapshotName}/contents |
POST | Upload |
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/contents |
GET | Download |
| View and Delete Files | ||
/interop/rest/{api_version}/applicationsnapshots |
GET | List Files (v11.1.2.3.600) |
/interop/rest/v2/files/list |
GET | List Files (v2) |
/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/v3/files/delete |
POST | Delete Files (v3) |
| Manage Services | ||
/interop/rest/{api_version}/services |
GET | Get Information About All Services |
/interop/rest/{api_version}/config/services/idlesessiontimeout |
GET | Get Idle Session Timeout |
/interop/rest/{api_version}/config/services/idlesessiontimeout |
PUT | Set Idle Session Timeout |
/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}/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) |
| Manage Application Snapshots | ||
/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 (v1) |
/interop/rest/v2/files/upload |
POST | Upload Application Snapshot (v2) |
/interop/rest/{api_version}/applicationsnapshots/{applicationSnapshotName}/content |
GET | Download Application Snapshot (v1) |
/interop/rest/v2/files/download |
POST | Download Application Snapshot (v2) |
/interop/rest/v1/services/{servicename}/copysnapshot |
POST | Copy Application Snapshot (v1) |
/interop/rest/v2/snapshots/copyfrominstance |
POST | Copy Application Snapshot (v2) |
/interop/rest/v1/renamesnapshot |
PUT | Rename Application Snapshot (v1) |
/interop/rest/v2/snapshots/rename |
PUT | Rename Application Snapshot (v2) |
| Copy to and from the Object Store | ||
/interop/rest/v1/services/copytoobjectstore |
POST | Copy to Object Store (v1) |
/interop/rest/v2/objectstorage/copyto |
POST | Copy to Object Store (v2) |
/interop/rest/v2/objectstorage/copyfrom |
POST | Copy from Object Store (v2) |
/interop/rest/v1/services/copyfile |
POST | Copy a File Between Instances (v1) |
| Working with Oracle Essbase | ||
/interop/rest/v2/essbase/export |
POST | Export Essbase Data (v2) |
/interop/rest/{api_version}/config/services/essbaseqrygovexectime |
GET | Get Essbase Query Governor Execution Time |
/interop/rest/{api_version}/config/services/essbaseqrygovexectime |
PUT | Set Essbase Query Governor Execution Time |
| Other | ||
/interop/rest/v1/services/copyfile |
POST | Copy a File Between Instances (v1) |
/interop/rest/v2/files/copyfrominstance |
POST | Copy a File Between Instances (v2) |
/interop/rest/v1/services/clone |
POST | Clone an Environment |
/interop/rest/{api_version}/config/services/virusscanonfileupload |
GET | Get Virus Scan on File Upload |
/interop/rest/{api_version}/config/services/virusscanonfileupload |
PUT | Set Virus Scan on File Upload |
/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 |
/interop/rest/{api_version}/services/dataaccess?accessType={allow|revoke}&disableEmergencyAccess={true|false} |
PUT | Manage Permission for Manual Access to Database (v1) |
/interop/rest/v2/services/setmanualdataaccess |
PUT | Manage Permission for Manual Access to Database (v2) |
/interop/rest/{api_version}/feedback |
POST | Provide Feedback (v11.1.2.3.600) |
/interop/rest/v2/services/feedback |
POST | Provide Feedback (v2) |
/interop/rest/<api_version>/services/sendmail |
POST | Send Email (v1) |
/interop/rest/v2/mails/send |
POST | Send Email (v2) |
/interop/rest/{api_version}/services/encryptionkey |
PUT | Set Encryption Key (v1) |
/interop/rest/v2/services/setencryptionkey |
PUT | Set Encryption Key (v2) |
/interop/rest/v1/services/skipupdate |
POST | Skip Updates (v1) |
/interop/rest/v2/services/skipupdate |
POST | Skip Updates (v2) |
/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 |
Daily Maintenance Window Time
Table 6-4 Daily Maintenance Window Time
| Rest Resource | Request | More Information |
|---|---|---|
/interop/rest/{api_version}/services/dailymaintenance |
GET | Get the Build Version and Daily Maintenance Time (v1) |
/interop/rest/v2/maintenance/getdailymaintenancestarttime |
GET | Get the Build Version and Daily Maintenance Window Time (v2) |
/interop/rest/{api_version}/services/dailymaintenance?StartTime={N} |
PUT | Setting the Daily Maintenance Time (v1) |
/interop/rest/v2/maintenance/setdailymaintenancestarttime |
PUT | Setting the Daily Maintenance Time (v2) |
/interop/rest/{api_version}/services/maintenancewindow |
POST | Running Daily Maintenance While Skipping the Scheduled Daily Maintenance (v1) |
/interop/rest/v2/maintenance/rundailymaintenance |
POST | Running Daily Maintenance While Skipping the Scheduled Daily Maintenance (v2) |
Managing Users
Table 6-5 Managing Users
| Rest Resource | Request | More Information |
|---|---|---|
/interop/rest/security/<api_version>/users |
POST | Add Users to an Identity Domain (v1) |
/interop/rest/security/v2/users/add |
POST | Add Users to an Identity Domain (v2) |
/interop/rest/security/<api_version>/users?filename=<filename> |
DELETE | Remove Users from an Identity Domain (v1) |
/interop/rest/security/v2/users/remove |
POST | Remove Users from an Identity Domain (v2) |
|
PUT | Assign Users to a Predefined Role or Application Role (v1) |
/interop/rest/security/v2/role/assign/user |
PUT | Assign Users to a Predefined Role or Application Role (v2) |
|
PUT | Remove Users' Role Assignment (v1) |
/interop/rest/security/v2/role/unassign/user |
PUT | Remove Users' Role Assignment (v2) |
/interop/rest/security/<api_version>/groups |
PUT | Add Users to a Group (v1) |
/interop/rest/security/v2/groups/adduserstogroup |
PUT | Add Users to a Group (v2) |
/interop/rest/security/<api_version>/groups |
PUT | Remove Users from a Group (v1) |
/interop/rest/security/v2/groups/removeusersfromgroup |
PUT | Remove Users from a Group (v2) |
/interop/rest/security/<api_verion>/users |
PUT | Update Users |
/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 Groups (v1) |
/interop/rest/security/v2/groups/add |
POST | Add Groups (v2) |
/interop/rest/security/<api_version>/groups |
DELETE | Remove Groups (v1) |
/interop/rest/security/v2/groups/remove |
POST | Remove Groups (v2) |
/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 (v1) |
/interop/rest/v2/reports/useraccess |
POST | User Access Report (v2) |
/interop/rest/{api_version}/reports?q={type:userauditreport,fileName:useraudit
report.csv,since:2017-12-10,until:2018-06-10} |
POST | User Audit Report (v1) |
/interop/rest/v2/reports/useraudit |
POST | User Audit Report (v2) |
/interop/restp{api_version}/reports/groupaudit |
POST | Group Assignment Audit 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 |
/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 |
/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 |
Usage Simulation
Table 6-6 Usage Simulation
| Rest Resource | Request | More Information |
|---|---|---|
/interop/rest/v1/concurrentusage/run |
POST | Simulate Concurrent Usage |
Reporting
Table 6-7 Reporting
| Rest Resource | Request | More Information |
|---|---|---|
/arm/rest/fcmapi/{api_version}/report |
POST | Generate Report for Account Reconciliation |
/HyperionPlanning/rest/fcmapi/{api_version}/report |
POST | Generate Report for Financial Consolidation and Close and Tax Reporting |
/arm/rest/fcmapi/{api_version}/rc/export/users |
POST | Generate User Details Report for Account Reconciliation |
/HyperionPlanning/rest/fcmapi/{api_version}/fcm/export/users |
POST | Generate User Details Report for Financial Consolidation and Close and Tax Reporting |
/arm/rest/fcmapi/{api_version}/job/{module}/{jobIdentifier} |
GET | Retrieve Job Status for a Report |
/aif/rest/{api_version}/jobs |
POST | Execute Reports for Data Management |
Data Management
Table 6-8 Data Management
| Rest Resource | Request | More Information |
|---|---|---|
/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/snapshots |
POST | Import Data Integration |
/aif/rest/V1/snapshots |
POST | Export Data Integration |
/aif/rest/{api_version}/jobs |
POST | Running Data Rules in Data Management |
/aif/rest/{api_version}/jobs |
POST | Running Integrations |
/aif/rest/{api_version}/jobs |
Running a Pipeline | |
/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/V1/POV |
POST | Lock and Unlock POV |
/aif/rest/{api_version}/jobs |
POST | Execute Reports for Data Management |
Account Reconciliation
Table 6-9 Account Reconciliation
| Rest Resource | Request | More Information |
|---|---|---|
/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 |
GET
/arm/rest/fcmapi/{api_version}/job/{module}/{jobIdentifier} |
GET | Retrieve Job Status for a Report |
/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 Account Reconciliation |
/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 |
/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 |
/arm/rest/fcmapi/{api_version}/{module}/connections |
POST | Create a Connection |
/arm/rest/fcmapi/{api_version}/{module}/connections |
GET | View All Connections |
/arm/rest/fcmapi/{api_version}/{module}/connections/{id} |
PUT | Update a Connection |
/arm/rest/fcmapi/{api_version}/{module}/connections/{id} |
DELETE | Delete a Connection |
/armARCS/rest/{api_version}/appaccess |
POST | Set Application Access Level |
/armARCS/rest/{api_version}/appaccess |
GET | Retrieve Application Access Level |
/armARCS/rest/{api_version}/jobs |
POST | Execute a Job in Account Reconciliation |
/armARCS/rest/periods?status={status} |
GET | Retrieve Periods with a Specific Status |
/armARCS/rest/{api_version}/jobs |
POST | Create Reconciliation (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Change Period Status (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Pre-Mapped Transactions (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Profiles (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Rates (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Balances (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Pre-Mapped Balances (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Reconciliation Attributes (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs/{job_id} |
GET | Retrieve Job Status (Reconciliation Compliance) |
/armARCS/rest/{api_version}/period/{period}/reconciliation/{accountId}/comments |
GET | View Reconciliation Comments |
/armARCS/rest/{api_version}/jobs |
POST | Monitor Reconciliations (Reconciliation Compliance) |
/armARCS/rest/{api_version}/jobs |
POST | Import Pre-Mapped Transactions (Transaction Matching) |
/armARCS/rest/{api_version}/jobs |
POST | Run Auto Match (Transaction Matching) |
/arm/rest/{api_version}/jobs |
POST | Purge Transactions (Transaction Matching) |
/arm/rest/{api_version}/jobs/{job_id} |
GET | Retrieve Job Status (Transaction Matching) |
/arm/rest/{api_version}/jobs |
POST | Archive Matched Transactions (Transaction Matching) |
/arm/rest/{api_version}/jobs |
POST | Purge Archived Transactions (Transaction Matching) |
/arm/rest/{api_version}/jobs |
POST | Unmatch Matched Transactions (Transaction Matching) |
/arm/rest/{api_version}/dataSources/{dataSource}/transactions/{transaction} |
POST | Update Unmatched Transactions (Transaction Matching) |
Financial Consolidation and Close
Table 6-10 Financial Consolidation and Close
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/ |
GET | Getting API Versions for Financial Consolidation and Close APIs |
/fccs/rest/{api_version} |
GET | Get Information about a Specific API Version for Financial Consolidation and Close APIs |
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Export Consolidation Journals |
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Import Consolidation Journals |
/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/{api_version}/applications/{application}/journals/{journal
label}?q={"scenario","year","period"}&lineItems=true |
GET | Retrieve Journal Details for Financial Consolidation and Close |
/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}/validatemetadata?logFileName=<filename
of exported results |
POST | Validate Metadata |
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Generate an Intercompany Matching Report |
|
|
PUT | Manage Permission for Manual Access to Database (v1) |
/interop/rest/v2/services/setmanualdataaccess |
PUT | Manage Permission for Manual Access to Database (v2) |
/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/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 |
Task Manager
Table 6-11 Task Manager
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/cmapi/{api_version}/updateTasksForEventMonitoring |
POST | Update Task Status for Event Monitoring |
/HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections |
POST | Create a Connection |
/HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections/{id} |
DELETE | Delete a Connection |
/HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections/{id} |
PUT | Update a Connection |
/HyperionPlanning/rest/fcmapi/{api_version}/{module}/connections |
GET | View All Connections |
/HyperionPlanning/rest/cmapi/{api_version}/jobs |
POST | Deploy Task Manager Templates |
Supplemental Data Manager
Table 6-12 Supplemental Data Manager
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs |
POST | Deploy Form Templates |
/HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs |
POST | Import Supplemental Collection Data for Financial Consolidation and Close |
Enterprise Journals
Table 6-13 Enterprise Journals
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/ej/{api_version}/jobs |
POST | Execute an Enterprise Journals Job |
/HyperionPlanning/rest/ej/{api_version}/jobs |
POST | Monitor Enterprise Journals 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/ej/{api_version}/ejjournals/{identifier}/validationstatus |
POST | Update Validation Status of Enterprise Journals for Financial Consolidation and Close |
Tax Reporting
Table 6-14 Tax Reporting
| Rest Resource | Request | More Information |
|---|---|---|
/HyperionPlanning/rest/ |
GET | Getting API Versions for Tax Reporting APIs |
/HyperionPlanning/rest/{api_version} |
GET | Get Information about a Specific API Version for Tax Reporting |
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Copy Data |
/HyperionPlanning/rest/{api_version}/applications/{application}/jobs |
POST | Clear Data |
Enterprise Profitability and Cost Management
Table 6-15 Enterprise Profitability and Cost Management
| Rest Resource | Request | More Information |
|---|---|---|
/epm/rest |
GET | Getting API Versions 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 | Generate Model Documentation Report |
/HyperionPlanning/rest/v3/applications/{AppName}/jobs/ |
POST | Validate Model |
Profitability and Cost Management
Table 6-16 Profitability and Cost Management
| Rest Resource | Request | More Information |
|---|---|---|
/epm/rest |
GET | Getting API Versions for Profitability and Cost Management REST APIs |
/epm/rest/{api_version}/applications/{application}/jobs/applyDataGrants |
POST | Apply Data Grants |
/epm/rest/{api_version}/applications/{application}/povs/{srcPOVMemberGroup}/jobs/copyPOVJob/{destPOVMemberGroup} |
POST | Copy ML POV Data |
/epm/rest/{api_version}/fileApplications/{application} |
POST | Create File-Based Application |
/epm/rest/{api_version}/applications/{application}/jobs/ledgerDeployCubeJob |
POST | Deploy ML Cube |
/epm/rest/{api_version}/fileApplications/{application}/enableApplication |
POST | Enable File-Based Application |
/epm/rest/{api_version}/applications/{application}/jobs/essbaseDataLoadJob |
POST | Essbase Data Load for Profitability and Cost Management |
/epm/rest/{api_version}/applications/{application}/jobs/exportQueryResultsJob |
POST | Export Query Results |
/epm/rest/{api_version}/applications/{application}/jobs/templateExportJob?fileName={fileName} |
POST | Export Template for Profitability and Cost Management |
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>/povs/<povName>/jobs/programDocReportJob |
POST | Generate Program Documentation Report - Run as a Job |
/epm/rest/{api_version}/applications/{application}/templateImportJob |
POST | Import Template for Profitability and Cost Management |
/epm/rest/{api_version}/applications/{application}/jobs/mergeSlices |
POST | Merge Slices for Profitability and Cost Management |
/epm/rest/v1/applications/{AppName}/jobs/optimizeASOCube |
POST | Optimize ASO Cube |
/epm/rest/{api_version}/applications/jobs/ChecktaskStatusJob/{processName} |
GET | Retrieve Task Status 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/clearPOVJob |
POST | Run ML Clear POV |
/epm/rest/{api_version}/applications/{application}/povs/{povGroupMember}/ruleBalance?queryParameter={"modelViewName":"modelViewName" |
POST | Run ML Rule Balancing |
/epm/rest/{api_version}/fileApplications/{application}/jobs/updateDimension |
POST | Update Dimensions As a Job |
/epm/rest/{api_version}/fileApplications/{application}/updateDimension |
POST | Update File-Based Application |