Cloud EPM REST APIs at a Glance

The following list summarizes all the REST APIs covered in this guide. Select an API category to navigate directly to its corresponding section within the table.

• Infrastructure REST APIs - The Infrastructure REST APIs are grouped under the categories listed below
  • Infrastructure: Managing Users, Groups, Roles, and Access Reports
  • Infrastructure: Migration
  • Infrastructure: Manage Services
  • Infrastructure: Manage Application Snapshots
  • Infrsastructure: Manage Artifacts, Snapshots, and Migration Status
  • Infrsastructure: First Generation
  • Infrsastructure: Security and Access Control
  • Infrsastructure: Maintenance Operations
• Account Reconciliation REST APIs
• Data Integration and Data Management REST APIs
• Enterprise Profitability and Cost Management REST APIs
• Financial Consolidation and Close REST APIs
• Planning REST APIs
• Tax Reporting REST APIs

Infrastructure: Managing Users, Groups, Roles, and Access Reports

Table 1-1 Infrastructure REST APIs: Managing Users, Groups, Roles, and Access Reports

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Add Users to an Identity Domain (v1)
Add Users to an Identity Domain (v2)
Remove Users from an Identity Domain (v1)
Remove Users from an Identity Domain (v2)
Assign Users to an Application Role or Granular Role (v1)
Assign Users to an Application Role or Granular Role (v2)
Remove Users' Role Assignment (v1)
Remove Users' Role Assignment (v2)
Add Users to a Group (v1)
Add Users to a Group (v2)
Remove Users from a Group (v1)
Remove Users from a Group (v2)
List Users (v1)
Update Users (v1)
Update Users (v2)
Add a User to a Batch of Groups (v1)
Remove a User from a Batch of Groups (v1)
Import User Group Assignments as CSV (v1)
Update Granular Roles For Groups (v1)
Update Granular Roles for Users (v1)
Add Groups (v1)
Add Groups (v2)
List Groups (v1)
Update Groups (v1)
Remove Groups (v1)
Remove Groups (v2)
User Group Report (v1)
User Group Report (v2)
User Access Report (v1)
User Access Report (v2)
User Audit Report (v1) (Deprecated)
User Audit Report (v2) (Deprecated)
User Login Report (v1)
Role Assignment Report (v1)
Role Assignment Report for Users (v2)
Role Assignment Report for Groups (v2)
Get Available Roles (v2)
Role Assignment Audit Report (v1)
Invalid Login Report (v1)
Group Assignment Audit Report (v2)
Adding Users to a Team for Account Reconciliation (only ARCS)
Adding Users to a Team for Financial Consolidation and Close and Tax Reporting
Removing Users from a Team for Account Reconciliation (only ARCS)
Removing Users from a Team for Financial Consolidation and Close and Tax Reporting

Infrastructure: Migration

Table 1-2 Infrastructure REST APIs: Migration

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Migration Status Codes
Get REST API Versions for Migration
LCM Import (v2)
LCM Export (v2)
Upload
Download
List Files (v2)
Delete Files (v2)
Delete Files (v3)
Copy from Object Store (v1)
Copy from Object Store (v2)
Copy from Object Store (v3)
Copy to Object Store (v1)
Copy to Object Store (v2)
Copy To Object Store (v3)
Copy to SFTP (v2)
Copy from SFTP (v2)
Copy a File Between Instances (v1)
Copy a File Between Instances (v2)
Clone an Environment (v1)
Provide Feedback (v2)
Send Email (v1)
Send Email (v2)
Set Email Domain Allowlist (v2)
Get Email Domain Allowlist (v2)
Skip Updates (v1)
Skip Updates (v2)
List Backups (v2)
Restore Backups (v2)
Restore Environment (v1)

Infrastructure: Manage Services

Table 1-3 Infrastructure REST APIs: Manage Services

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Get Information About All Services
Get Idle Session Timeout (v2)
Set Idle Session Timeout (v2)
Restart the Service Instance (v1)
Restart the Service Instance (v2)
Run Recreate on a Service (v2)

Infrastructure: Manage Application Snapshots

Table 1-4 Infrastructure REST APIs: Manage Application Snapshots

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Get Information About a Specific Application Snapshot
Get Information About All Application Snapshots
Upload Application Snapshot (v1)
Upload Application Snapshot (v2)
Download Application Snapshot (v1)
Download Application Snapshot (v2)
Copy Application Snapshot (v1)
Copy Application Snapshot (v2)
Rename Application Snapshot (v1)
Rename Application Snapshot (v2)

Infrsastructure: Manage Artifacts, Snapshots, and Migration Status

Table 1-5 Infrsastructure REST APIs: Manage Artifacts, Snapshots, and Migration Status

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Pofitability	Tax Reporting
Export Categories Artifacts (v2)
Get Categories (v2)
Get Migration Status (v2)
Get Snapshot Modification History (v2)
Import Snapshot Artifacts (v2)
List the Artifacts in a Category (v2)
List Updated Artifacts (v2)
List Snapshot Details (v2)
List the Artifacts in a Snapshot (v2)
List Import Options (v2)
Repeat Export Snapshot (v2)
Set Import Options (v2)

Infrsastructure: First Generation

Table 1-6 Infrsastructure REST APIs: First Generation

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
LCM Import
LCM Export
List Files
Delete Files
Run Recreate on a Service
Provide Feedback

Infrsastructure: Security and Access Control

Table 1-7 Infrsastructure REST APIs: Security and Access Control

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Get Restricted Data Access (v2)
Set Restricted Data Access (v2)
Get Virus Scan on File Upload (v2)
Set Virus Scan on File Upload (v2)
Manage Permission for Manual Access to Database (v1)
Manage Permission for Manual Access to Database (v2)
Set Encryption Key (v1)
Set Encryption Key (v2)
Support for IAM REST APIs

Infrsastructure: Maintenance Operations

Table 1-8 Infrsastructure REST APIs: Maintenance Operations

REST API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Get the Build Version and Daily Maintenance Time (v1)
Get the Build Version and Daily Maintenance Window Time (v2)
Set the Daily Maintenance Time (v1)
Set the Daily Maintenance Time (v2)
Run Daily Maintenance While Skipping the Scheduled Daily Maintenance (v1)
Run Daily Maintenance While Skipping the Scheduled Daily Maintenance (v2)
Simulate Concurrent Usage (v1)

Account Reconciliation REST APIs

Table 1-9 Account Reconciliation REST APIs

REST API	Planning	Freeform	Consilidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Archive Matched Transactions (Transaction Matching)
Change Period Status (Reconciliation Compliance)
Create Reconciliation (Reconciliation Compliance)
Create a Connection
Delete Profile
Delete a Connection
Execute a Job in Account Reconciliation
Export Application Properties
Export Background Image
Export Logo Image
Generate Balance Summary Report for Account Reconciliation
Generate Balance Report Transactions for Account Reconciliation
Generate Cosmetic Changes Report for Account Reconciliation
Generate Report for Account Reconciliation
Generate User Details Report for Account Reconciliation
Import Application Properties
Import Attribute Values
Import Background Image
Import Balances (Reconciliation Compliance)
Import Logo Image
Import Pre-Mapped Balances (Reconciliation Compliance)
Import Pre-Mapped Transactions (Reconciliation Compliance)
Import Profiles (Reconciliation Compliance)
Import Rates (Reconciliation Compliance)
Import Pre-Mapped Transactions (Transaction Matching)
Import Reconciliation Attributes (Reconciliation Compliance)
Monitor Reconciliations (Reconciliation Compliance)
Predict Predicted Attribute (Reconciliation Compliance)
Purge Transactions (Transaction Matching)
Purge Archived Transactions (Transaction Matching)
Retrieve Periods with a Specific Status
Run Auto Match (Transaction Matching)
Retrieve Job Status (Reconciliation Compliance)
Retrieve Job Status (Transaction Matching)
Retrieve Application Access Level
Run Auto Alert (Transaction Matching)
Run Train Match Prediction (Transaction Matching)
Run Profile Rule
Run Reconciliation Rule
Set Application Access Level
Train Predicted Attribute (Reconciliation Compliance)
Unmatch Matched Transactions (Transaction Matching)
Unmatch Transactions Matched by Auto Match (Transaction Matching)
Update Unmatched Transactions (Transaction Matching)
Update a Connection
View Reconciliation Comments
View All Connections

Data Integration and Data Management REST APIs

Table 1-10 Data Integration and Data Management REST APIa

Rest API	Plannning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Get Pipeline Details
Import Data Mapping
Import Data Integration
Export Data Mapping
Export Data Integration
Lock and Unlock POV
Run Integrations
Run a Pipeline
Run Data Rules in Data Management
Running Batch Rules in Data Management
Retrieve Job Status
Update Connection in Data Integration

Enterprise Profitability and Cost Management REST APIs

Table 1-11 Enterprise Profitability and Cost Management REST APIs

Rest API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Calculate Model (v3)
Clear Data By Point of View (v3)
Copy Data by Point of View
Delete Point of View
Generate Model Documentation Report
Validate Model

Financial Consolidation and Close REST APIs

Table 1-12 Financial Consolidation and Close REST APIs

Rest API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Clear Data
Copy Data
Export Configurable Consolidation Rulesets
Export Consolidation Journals
Generate an Intercompany Matching Report
Generate Report for Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management and Planning
Generate User Details Report for Financial Consolidation and Close and Tax Reporting
Getting API Versions for Financial Consolidation and Close APIs
Get Information about a Specific API Version for Financial Consolidation and Close APIs
Import Configurable Consolidation Rulesets
Import Consolidation Journals
Perform Journal Actions for Financial Consolidation and Close
Perform Journal Period Updates for Financial Consolidation and Close
Retrieve Job Status for a Report
Retrieve Journals for Financial Consolidation and Close
Retrieve Journal Details for Financial Consolidation and Close
Validate Metadata

Planning REST APIs

Table 1-13 Planning REST APIs

Rest API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Add Member
Change Planning Unit Status
Clear Data Slice
Create or Update All Substitution Variables Defined for the Application
Create User Variables
Delete a Substitution Variable at the Plan Type Level
Delete a Substitution Variable for the Application
Delete a User Variable
Delete Substitution Variables at the Plan Type Level
Delete Substitution Variables for the Application
Delete User Variable Definitions
Execute a Job
Export Data Slice
Get a Derived Substitution Variable Defined at the Plan Type Level
Get a Planning Unit Owner Photo
Get a Substitution Variable Defined for the Application
Get All Substitution Variables Defined for the Application
Get All User Variables
Get Applications
Get Application Summary
Get Available Planning Unit Actions
Get Derived Substitution Variables at the Plan Type Level
Get Dimensions for a Plan Type
Get Dimension Details
Get Filters with All Possible Values
Get Information about a Specific REST API Version for Planning
Get Job Definitions
Get Member
Get Planning Unit History and Annotations
Get Planning Unit Promotional Path
Get Plan Types
Get Substitution Variables Defined at the Plan Type Level
Get User Preferences
Get User Variable Values Defined for the Application
Get User Variable Values Defined for the Application by the User Name
Get User Variable Values Defined in the Application by the User Name and Value
Get User Variable Values Defined in the Application by the User Variable Name
Get User Variable Values Defined in the Application by Value
Get a User Variable Using Its ID
Getting API Versions for Planning
Import Data Slice
List Library Documents
List All Planning Units
Retrieve Child Job Status Details
Retrieve Job Status
Retrieve Job Status Details
Set the User Variable Values for the Application
Update User Variables

Tax Reporting REST APIs

Table 1-14 Tax Reporting REST APIs

Rest API	Planning	Freeform	Consolidation	Account Reconciliation	Enterprise Profitability	Tax Reporting
Copy Data
Clear Data
Generate Report for Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management and Planning
Generate User Details Report for Financial Consolidation and Close and Tax Reporting
Getting API Versions for Tax Reporting APIs
Get Information about a Specific API Version for Tax Reporting
Retrieve Job Status for a Report