Export Configurable Consolidation Rulesets

This REST API launches an Export Configurable Consolidation Rulesets job for Financial Consolidation and Close, which exports the rulesets specified in the request to an xml file. The exported xml file, named Configurable_Consolidation.xml, can be downloaded from the Job Details page and edited as needed. The contents and structure of the xml file is similar to that exported through the user interface.

Required Roles

Service Administrator

REST Resource

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

Request

Supported Media Types: application/json

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

Table 18-21 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
rules	Array of ruleset names that needs to be exported, for example: { "rules"=["Test1","Test2"] }	Payload	Yes	None

Sample Request

{
"rules"= ["Test1","Test2"]
}

Response

Supported Media Types: text/plain

Examples of Response Body

Response is job submission message, or an error message, if any, for example:

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

If rules specified in the request body don't exist in the application, then the generated job will be errored out and the error file can be downloaded from the Job Details page.

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

Please enter rules to be exported.