Cube Refresh

Refreshes the Planning application cube. Typically, you refresh the cube after importing metadata into the application.

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-17 Cube Refresh

Name Description Required Default
jobType Cube Refresh or CUBE_REFRESH (both parameters are supported) Yes None
jobName Name of the job to run.

You must use the exact name of a job that is already defined in the application.

Example: refreshcube

Yes None
allowedUsersDuringCubeRefresh Possible values: Administrators or All Users No None
terminateActiveRequestsBeforeCubeRefresh Possible values: true or false No None
logOffAllUsersBeforeCubeRefresh Possible values: true or false No None
allowedUsersAfterCubeRefresh Possible values: Administrators or All Users No None

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

{"jobType":"CUBE_REFRESH","jobName":"CubeRefresh"}

Sample Payload overriding parameters:

{"jobType":"CUBE_REFRESH","jobName":"MyRefreshCube","parameters":{"allowedUsersDuringCubeRefresh":"   All Users", "terminateActiveRequestsBeforeCubeRefresh":"false","logOffAllUsersBeforeCubeRefresh":"true","allowedUsersAfterCubeRefresh":"Administrators"}}