Deploy ML Cube

Deploy or redeploy the calculation cube for a selected Profitability and Cost Management application.

REST Resource

POST /epm/rest/{api_version}/applications/{application}/jobs/ledgerDeployCubeJob

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 13-13 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application Name of the application for which to deploy the cube Path Yes None
isKeepData Specify whether to preserve existing data Payload Yes None
isReplaceCube Specify whether to replace existing cube

Note:

Both isKeepData and isReplaceCube cannot be true at the same time.

Payload Yes None
isRunNow Run now or schedule for later. (Schedule for later is not currently supported.) Payload Yes None
comment Any user comments Payload Yes None

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/{applicationName}/jobs/ledgerDeployCubeJob

{"isKeepData":"true","isRunNow":"true","comment":"Test Ml Deploy"}

Response Body

Supported Media Types: application/json

Table 13-14 Parameters

Name Description
details In case of errors, details are published with the error string
status See Migration Status Codes
statusMessage Message about the status, such as In Progress
type Profitability
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Relationship type
data Parameters as key value pairs passed in the request

Example of Response Body:

The following shows an example of the response body in JSON format.

{
  "type": "Profitability",
  "links": [
    {
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/LM1T2/jobs/ledgerDeployCubeJob",
      "action": "POST",
      "rel": "self",
      "data": {
        "isRunNow": true,
        "isReplaceCube": true,
        "comment": "Test Ml Deploy"
      }
    },
    {
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/jobs/ChecktaskStatusJob/LM1T2_LM1T2_DeployCube_D20160113T065447_b64_1",
      "action": "GET",
      "rel": "Job status"
    }
  ],
  "status": -1,
  "details": "LM1T2_LM1T2_DeployCube_D20160113T065447_b64_1",
  "statusMessage": "In Progress"
}