Oracle Fusion Cloud EPM REST APIs

https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest
Admin
This documentation provides details and examples for using REST APIs to interact with Oracle Fusion...
Tokens:654,041
Snippets:3,414
Trust Score:9.7
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example URL

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/get_export_form_data.html

Example URL showing query parameters for page members, display member as, force start expanded, and fields.

```text
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<APPLICATION>/forms/<FORM_ID_OR_NAME>/data?page=<PAGE_MEMBER_1>&page=<PAGE_MEMBER_2>&displayMemberAs=<DISPLAY_MEMBER_AS>&forceStartExpanded=<TRUE_FALSE>&fields=<FIELDS_LIST>
```

--------------------------------

### Example URL for GET /armARCS/rest/v1/appacess

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/arcs_get_application_access.html

Example URL for the request. Note the typo 'appacess' in the example URL, while the resource path uses 'appaccess'.

```text
https://<BASE-URL>/armARCS/rest/v1/appacess
```

--------------------------------

### Download Link - Example URL

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot_v2.html

GET request to obtain the download link. The JOB-ID is from the status response.

```http
https://<BASE-URL>/interop/rest/v2/files/download/<JOB-ID>
```

--------------------------------

### Example URL: Get User Variable Values for Member 'Apr'

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_user_variables_for_mem.html

Example URL for the endpoint, using application 'Vision' and member 'Apr'. This is the base example without paging.

```http
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"member":"Apr"}
```

--------------------------------

### Example URL for setdailymaintenancestarttime

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/lcm_update_maintenance_time_v2.html

The base URL for the PUT request to set the daily maintenance start time.

```http
https://<BASE-URL>/interop/rest/v2/maintenance/setdailymaintenancestarttime
```

--------------------------------

### Example URL for Get Planning Unit Promotional Path

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/get_planning_unit_promotional_path.html

Shows the URL structure for the GET request. The planning unit identifier includes the scenario, version, and PM member, with special characters URL-encoded.

```text
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/Forecast::"BU                     Version_1"::Dev/promotionpath
```

--------------------------------

### GET Daily Maintenance with Access Token - Linux

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/authentication_oath.html

Example curl command for Linux to get the Automated Maintenance Window start time by calling the /interop/rest/v1/services/dailymaintenance endpoint with the access token in the Authorization header.

```bash
curl --location --request GET 'https://epm-host/interop/rest/v1/services/dailymaintenance' \
--header 'Authorization: Bearer eyJ5M4QjUkI...abSjZaa86PlseS4lrt7R2'
```

--------------------------------

### Example URL for View All Connections

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/epm_connections_get_all_connections.html

Example URL showing paging parameters offset=2 and limit=2.

```text
https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections?offset=2&limit=2
```

--------------------------------

### GET Daily Maintenance with Access Token - Windows PowerShell

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/authentication_oath.html

Example curl command for Windows PowerShell to get the Automated Maintenance Window start time by calling the /interop/rest/v1/services/dailymaintenance endpoint with the access token in the Authorization header.

```powershell
curl --location --request GET 'https://epm-host/interop/rest/v1/services/dailymaintenance' `
--header 'Authorization: Bearer eyJ5M4QjUkI...abSjZaa86PlseS4lrt7R2'
```

--------------------------------

### Initiate Download - Example Response 1

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot_v2.html

Response to the initiate download request. Status -1 indicates the job is in progress. The links provide the status and download endpoints.

```json
{
    "details": null,
    "status": -1,
    "links": [
        {
            "href": " https://<BASE-URL>/interop/rest/v2/files/download",
            "action": "POST",
            "rel": "self",
            "data": null
        },
        {
            "href": " https://<BASE-URL>/interop/rest/v2/status/download/<JOB-ID>",
            "action": "GET",
            "rel": "Job Status",
            "data": null
        }
    ]
}
```

--------------------------------

### GET Daily Maintenance with Access Token - Windows Command Prompt

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/authentication_oath.html

Example curl command for Windows Command Prompt to get the Automated Maintenance Window start time by calling the /interop/rest/v1/services/dailymaintenance endpoint with the access token in the Authorization header.

```cmd
curl --location --request GET "https://epm-host/interop/rest/v1/services/dailymaintenance" ^
--header "Authorization: Bearer eyJ5M4QjUkI...abSjZaa86PlseS4lrt7R2"
```

--------------------------------

### Initiate Download - Example URL and Payload

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot_v2.html

POST request to initiate a download. The payload specifies the snapshot file name. Requires Basic Authorization header.

```http
https://<BASE URL>/interop/rest/v2/files/download
```

```json
{
    "fileName": "<SNAPSHOT-NAME>.zip"
}
```

--------------------------------

### Example URL for available planning unit actions

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/get_available_planning_unit_actions.html

Example URL using the REST resource with query parameter q={"options":1} to return full approvals functionality.

```http
https://<BASE-URL>/rest/v3/applications/PS4app1/planningunits/Forecast::"BU                     Version_1"/availableactions?q={"options":1}
```

--------------------------------

### Get Lock Status REST API Resource Example

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/fdmee_lock_unlock.html

Example REST resource URL for getting lock status, using application=FCCSAPP1, period=Jan-17, and category=Actual.

```http
/aif/rest/V1/POV?application=FCCSAPP1&period=Jan-17&category=Actual
```

--------------------------------

### Example Request URL for GET /HyperionPlanning/rest/ej/v1/ejjournals/100000000008821

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/fccs_get_enterprise_journal_details.html

Example request URL using api_version v1 and instanceId 100000000008821.

```http
GET       /HyperionPlanning/rest/ej/v1/ejjournals/100000000008821
```

--------------------------------

### Example Response 1

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/upload_application_snapshot_v2.html

Sample response from the create file request. Shows status, details, and links with self rel.

```json
{
	"status":0,
	"details":null,
	"links":[{
		"data":null,
		"action":"POST",
		"href":"https://<BASE-URL>/interop/rest/v2/interop/rest/v2/files/upload,
		"rel":"self"
	}]
}
```

--------------------------------

### Example Response for View All Connections

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/arcs_connections_get_all_connections.html

A sample JSON response showing the links, details, and items array with connection details such as username, url, id, and type.

```json
{
    "links": [
        {
            "rel": "self",
            "href": "https://<BASE-URL>/arm/rest/fcmapi/v1/rc/connections",
            "action": "GET"
        }
    ],
    "details": null,
    "items": [
        {
            "username": "ats_admin2",
            "password": null,
            "url": "https://<BASE-URL>",
            "id": 100000000558005,
            "type": "ENTERPRISE_JOURNALS"
        }
    ]
}
```

--------------------------------

### Example URL for enabling a file-based application

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/pcmc_enable_file_based_app.html

Shows the URL format for the enableApplication endpoint. Replace <BASE-URL> with your actual base URL and BksML12 with the application name.

```http
https://<BASE-URL>/epm/rest/v1/fileApplications/BksML12/enableApplication
```

--------------------------------

### Response for Get Data Integration Objects

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/di_connections_update_a_connection.html

Example response payload for the GET objects command, listing object types and their refUrls.

```json
{
  "status": 0,
  "details": null,
  "response": [
    {
      "objectType": "integrations",
      "refUrl": "https://<BASE-URL>/aif/rest/V1/objects/integrations"
    },
    {
      "objectType": "applications",
      "refUrl": "https://<BASE-URL>/aif/rest/V1/objects/applications"
    },
    {
      "objectType": "pipelines",
      "refUrl": "https://<BASE-URL>/aif/rest/V1/objects/pipelines"
    },
    {
      "objectType": "connections",
      "refUrl": "https://<BASE-URL>/aif/rest/V1/objects/connections"
    }
  ]
}
```

--------------------------------

### Example of Request

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot.html

Example URL for the download application snapshot request. The BASE-URL is a placeholder and the snapshot name is 'Vision.zip'.

```text
https://<BASE-URL>/interop/rest/v1/applicationsnapshots/Vision.zip/contents
```

--------------------------------

### Example Request URL: GET /HyperionPlanning/rest/ej/v1/ejjournalcontent?Year=2018&Period=Jan&JournalId=100000001

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/fccs_get_enterprise_journal_details_by_year.html

An example request URL for the API, using Year=2018, Period=Jan, and JournalId=100000001.

```http
GET       /HyperionPlanning/rest/ej/v1/ejjournalcontent?Year=2018&Period=Jan&JournalId=100000001
```

--------------------------------

### Example URL for status=ALL

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/arcs_rest_get_periods.html

Example URL that retrieves all periods. Replace <BASE-URL> with the actual base URL.

```http
https://<BASE-URL>oraclecloud.com/armARCS/rest/periods?status=ALL
```

--------------------------------

### Example Response Body for Get Virus Scan on File Upload

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/lcm_get_virus_scan_on_file_upload.html

Example response body for the Get Virus Scan on File Upload REST API. Shows the structure with details, links, status, and items, where the scanfiles field indicates whether virus scan is enabled.

```json
{
       "details": null,
       "links": [{
             "rel": "self",
             "href": "<uri>/interop/rest/v2/config/services/virusscanonfileupload",
             "data": "null",
             "action": "GET"
       }],
       "status": "0",
       "items": [{
             "scanfiles": "true"           
       }]
}
```

--------------------------------

### Example response body for GET periods

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/arcs_rest_get_periods.html

Example JSON response body showing a list of periods with status 53 (CLOSED) and a self link.

```json
{
  "type": "ARCS",
  "items": [
    {
      "Status": "53",
      "Id": "100000000135004",
      "Name": "January 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135007",
      "Name": "February 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135009",
      "Name": "March 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135011",
      "Name": "April 2022"
    }
  ],
  "status": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/armARCS/rest/periods",
      "action": "GET"
    }
  ]
}
```

--------------------------------

### Example of Response Body

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_del_all_subst_variables_for_app.html

Response body example showing items with name, value, and planType.

```json
{
    "items": [{
        "name": "CurrYear",
        "value": "FY16",
        "planType": "ALL"
    }, {
        "name": "CurrYear",
        "value": "FY17",
        "planType": "Plan2"
    },{
        "name": "CurrPeriod",
        "value": "Jan",
        "planType": "Plan1"
    }, {
        "name": "CurrPeriod",
        "value": "Feb",
        "planType": "ALL"
    }]
}
```

--------------------------------

### Initiate Download - Sample cURL command

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot_v2.html

cURL command to initiate the download. Saves response headers to respHeader.txt and response body to response.txt.

```bash
curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d
'{"fileName":"<SNAPSHOT-NAME>.zip"}' 'https://<BASE-URL>/interop/rest/v2/files/download'
```

--------------------------------

### Example of Response Body

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/arcs_rest_import_recon_attributs.html

Example JSON response body showing status -1 (In Progress), details 'In Process', and a self link with action GET.

```json
{
    "type": "ARCS",
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/100000001155018",
            "action": "GET"
        }
    ],
    "details": "In Process",
    "status": -1
}
```

--------------------------------

### Example URL with Paging: offset=0&limit=5

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_user_variables_for_mem.html

Example URL with optional paging parameters offset and limit. The offset is 0-based and limit controls how many items to return; a limit of 0 or -1 returns all records.

```http
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"member":"Apr"}&offset=0&limit=5                 
```

--------------------------------

### Example response body for GET substitution variable

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_a_subst_variables_defined_at_plan_type_level_7.html

Example JSON response body showing the substitution variable details including name, value, planType, and links.

```json
{
    "name": "CurrYear",
    "value": "FY17",
    "planType": "Plan1",
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/vision/plantypes/plan1/substitutionvariables/CurrYear",
        "action": "GET"
    }]
}
```

--------------------------------

### Example URL for GET substitution variables

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_derived_subst_variables_at_plan_type_level_6.html

An example URL using the REST API with specific values for the path parameters and the derivedValues query parameter set to true.

```http
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/substitutionvariables?q={"derivedValues":true}
```

--------------------------------

### Example response body for available planning unit actions

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/get_available_planning_unit_actions.html

Example JSON response body containing the list of available actions and links.

```json
{
    "items": [{
        "actionId": 6,
        "name": "Promote"
    }, {
        "actionId": 3,
        "name": "Sign Off"
    }, {
        "actionId": 1,
        "name": "Reject"
    }, {
        "actionId": 7,
        "name": "Delegate"
    }, {
        "actionId": 8,
        "name": "Take Ownership"
    }, {
        "actionId": 9,
        "name": "Originate"
    }, {
        "actionId": 10,
        "name": "Freeze"
    }],
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4_HP2/planningunits/Current::%22BU%20Version_1%22/availableactions?q=%7Boptions:1%7D",
        "action": "GET",
        "data": {
            "pmMembers": "ent_111: Regular Coke"
        }
    }],
}
```

--------------------------------

### Example URL for GET substitution variable

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_a_subst_variables_defined_at_plan_type_level_7.html

An example URL using the REST resource with specific values: api_version v3, application vision, plantype plan1, and variable CurrYear.

```http
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/vision/plantypes/plan1/substitutionvariables/CurrYear
```

--------------------------------

### Example of Response Body (Initiate the download)

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/download_application_snapshot.html

Response body when the download is initiated. The status is -1 and the links include a self link and a job status link.

```json
{{
    "details": null,
    "status": -1,
    "links": [
        {
            "href": "https://<BASE-URL>/interop/rest/v1/applicationsnapshots//<SNAPSHOT-NAME>/contents",
            "action": "GET",
            "rel": "self",
            "data": null
        },
        {
            "href": "https://<BASE-URL>/interop/rest/v1/applicationsnapshots/<SNAPSHOT-NAME>/contents/<JOB-ID>",
            "action": "GET",
            "rel": "Job Status",
            "data": null
        }
    ]
}
```

--------------------------------

### Example response body for GET substitution variables

Source: https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/planning_get_derived_subst_variables_at_plan_type_level_6.html

An example JSON response body showing the items array with substitution variable details, including name, value, and planType.

```json
{
    "items": [{
        "name": "CurrYear",
        "value": "FY16",
        "planType": "ALL"
    }, {
        "name": "CurrPeriod",
        "value": "Jan",
        "planType": "Plan1"
    }]
}
```
Tokens:
Raw