Enable File-Based Application

Enables an application using a flat file.

Required Roles

Service Administrator, Power User

REST Resource

POST /epm/rest/{api_version}/fileApplications/{application}/enableApplication

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 24-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 to enable	Path	Yes	None

Example URL

https://<EPM-CLOUD-BASE-URL>/epm/rest/v1/fileApplications/BksML12/enableApplication

Response

Supported Media Types: application/json

Table 24-14 Parameters

Name	Description
details	Task ID, such as BksMl12_BksMl12_EnableApplication_D20160113T075011_53c_1
status	See Migration Status Codes
statusMessage	Message about the status, such as Success
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.

{
   "type":"Profitability",
   "status":-1,
   "statusMessage":"In Progress",
   "details":"BksML30_EnableApplication_D20220511T114947_65c",
   "links":[
      {
         "href":"http://<BASE-URL>/epm/rest/v1/applications/jobs/ChecktaskStatusJob/BksML30_EnableApplication_D20220511T114947_65c",
         "action":"GET",
         "rel":"Job Status"
      }
   ]
}

Java Sample – EnableApplication.java for Profitability and Cost Management

Prerequisites: json.jar

Common Functions: See Profitability and Cost Management Common Helper Functions for Java

    public void enableApplication() throws Exception {
        String urlString = "%s/epm/rest/%s/fileApplications/%s" +"/enableApplication";
        executeJob(urlString, "POST", null);
    }   

cURL Sample – EnableApplication.sh for Profitability and Cost Management

Common Functions: See Profitability and Cost Management Common Helper Functions for cURL.

funcEnableApplication() {
	url=$SERVER_URL/epm/rest/$API_VERSION/fileApplications/$APP_NAME/enableApplication
	funcExecuteRequest "POST" $url "application/json"

	output=`cat response.txt`
	status=`echo $output | jq '.status'`
    if [ $status == -1 ]; then
        echo "Started Enabling Application successfully"
		funcGetStatus "GET"
    else
        error=`echo $output | jq '.details'`
        echo "Error occurred. " $error
    fi
	funcRemoveTempFiles "respHeader.txt" "response.txt"
}

Groovy Sample – EnableApplication.groovy for Profitability and Cost Management

Prerequisites: json.jar

Common Functions: See Appendix C: Common Helper Functions for Groovy.

def enableApplication() {
    
        String urlString = serverUrl + "/epm/rest/"+ apiVersion + "/fileApplications/"+ appName +"/enableApplication";
        def url;
        
        try {
                 url = new URL(urlString)
        } catch (MalformedURLException e) {
                 println "Malformed URL. Please pass valid URL"
                 System.exit(0);
        }        
        executeJob(url, "POST", null);
}