Plan Type Map

Copies data from a block storage database to an aggregate storage database or from a block storage to another block storage based on the settings specified in a Planning job of type plan type map. See for details about plan type maps.

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.

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 5-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 Planning application.

Example: CampaignToReporting

Yes None
parameters

Optionally, you can specify the clearData parameter that indicates whether the data in the target database should be moved before copying data. If this parameter value is not set, the default value True is used.

The value must use JSON syntax.

Example: {clearData:false}

No True

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/jobs

{"jobType":"PLAN_TYPE_MAP","jobName":"MapReporting","parameters":{"cubeLinkName":"name","clearData":true}}