Import Configurable Consolidation Rulesets

This REST API launches an Import Configurable Consolidation Rulesets job, which imports the specified ruleset xml into Financial Consolidation and Close, after validation of the specified rulesets. The import validation process is similar to that implemented in the Import Configurable Consolidation Rulesets user interface.

The xml file can be uploaded to the Planning Inbox/Outbox using the EPM Automate uploadFile command.

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/importConfigConsolRules

Request

Supported Media Types: application/json

The following table summarizes the client request parameters specific to this job.

Table 18-22 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with: v3	Path	Yes	None
application	The name of the application	Path	Yes	None
file	Name of the xml file located at the Planning Inbox/Outbox location, for example: {"file" = "inbox/Configurable_Consolidation.xml" }	Payload	Yes	None

Sample Request

{
"file" = "inbox/Configurable_Consolidation.xml"
}

Response

Supported Media Types: text/plain

Examples of Response Body

Response is job submission message, or an error message, if any.

The import details can be seen from submitted Job Details page, for example:

Job is submitted. See the job console for more information.

If any error exists in the rules specified in the xml file while importing/validating, the error details can be viewed on the Job Details page.

If the file parameter is not specified in the request, or if no value is provided for the file parameter, the following error message will be returned as the response:

Please enter the name of the file located at Inbox/Outbox location.