Import Template for Oracle Profitability and Cost Management Cloud

Import a template zip file as an application from the inbox.

REST Resource

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

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 13-36 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application Name of the application Path Yes None
description User comment for the application Payload Yes None
fileName Name of the template zip file to be imported from the inbox folder Payload Yes None
isApplicationOverwrite Whether to override an application if one already exists with same name. Values are
true
or
false
.
Payload Yes None

Example URL and payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/Ex3F3/jobs/templateImportJob

{"description":"description","fileName":" testFile12345.zip","isApplicationOverwrite":"true"}

Response Body

Supported Media Types: application/json

Table 13-37 Parameters

Name Description
details Task ID, such as TD_ae61e427d9ab4d6f99e3b87378fa1c94
status See Migration Status Codes
statusMessage Message about the status, such as In Progress
type Profitability
data Parameters as key value pairs
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.

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/Ex3F3/jobs/templateExportJob?fileName=test123",
       
{
    "type": "Profitability",
    "status": -1,
    "statusMessage": "In Progress",
    "details": "TD_ae61e427d9ab4d6f99e3b87378fa1c94",
    "links": [{
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/SMBk12Ts/jobs/templateImportJob",
        "rel": "self",
        "data": {
            "instanceName": "PROFITABILITY_WEB_APP",
            "essApplicationServer": "EssbaseCluster-1",
            "sharedServicesProject": "Default Application Group",
            "description": "description",
            "isApplicationOverwrite": true,
            "fileName": "HPCM_BksML12.zip"
        },
        "action": "POST"
    }, {
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/jobs/ChecktaskStatusJob/TD_ae61e427d9ab4d6f99e3b87378fa1c94",
        "rel": "Job Status",
        "action": "GET"
    }]
}