Cube Refresh

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

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic 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 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

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"}}