Plan Type Map
Copies data from a block storage cube to an aggregate storage cube or from one to another
based on the settings specified in a job of type plan type map
.
For details about data maps, see Defining Data Maps in Administering Data Integration for Oracle Enterprise Performance Management Cloud.
This API is not supported for Financial Consolidation and Close or Tax Reporting.
Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.
Table 8-12 Plan Type Map
Name | Description | Required | Default |
---|---|---|---|
jobType |
Plan Type Map or PLAN_TYPE_MAP (both
parameters are supported)
|
Yes | None |
jobName |
The name of a job of type plan type map that is already defined in the application. Example: |
Yes | None |
parameters |
Optionally, you can specify these parameters:
|
No | None |
Example URL and Payload
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/jobs
{
"jobType": "PLAN_TYPE_MAP",
"jobName": "MapReporting",
"parameters": {
"cubeLinkName": "name",
"clearData": true
}
}
Examples of overriding selections of the data map:
{
"jobType": "PLAN_TYPE_MAP",
"jobName": " MapReporting",
"parameters": {
"cubeLinkName": "MapChannels",
"clearData": true,
"overrideMembersMap": {
"Period": "ILvl0Descendants(Q1)"
},
"overrideExclusionMembersMap": {
"Period": "Jan"
}
}
}
"overrideMembersMap": {
"Period": "ILvl0Descendants(Q1)"
}
"overrideMembersMap": {
"Period": "ILvl0Descendants(Q1)",
"Account": "Sales"
}
Examples of excluding members:
"overrideExclusionMembersMap": {
"Period": "Jan"
}
"overrideExclusionMembersMap": {
"Period": "Jan, Feb, &CurrMonth, ILvl0Descendants(Q1), YearTotal, Red"
}