Export Valid Intersections

This REST API exports valid intersection groups (certain cell intersections filtered by rules when users enter data or select runtime prompts) from Financial Consolidation and Close, Planning, or Tax Reporting business processes.

The output is a ZIP file that is added to the Outbox. You can download the file using the Download REST API.

Note the following requirements for the format of the Excel file used with this REST API.

The exported Excel file contains two worksheets with these names:

1. Rules
2. Sub Rules

The Rules worksheet has the following column headings:

• Name
• Position
• Description
• Enabled
• Anchor Dim Name
• Anchor Dimension Apply to Unselected Members
• Dim1
• Dim1 Required
• Dim2
• Dim2 Required
• DimX
• DimX Required

The Sub Rules worksheet has the following column headings:

• Name - This column contains the names of the Rules from the first worksheet
• Anchor Members
• Anchor Exclusion
• Dim1 Members
• Dim1 Exclusion
• Dim2 Members
• Dim2 Exclusion
• DimX Members
• DimX Exclusion

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator

REST Resource

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

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For parameters that are common to all jobs, see Execute a Job.

Table 8-34 Export Valid Intersections

Name	Description	Required	Default
jobType	Export Valid Intersections or EXPORT_VALID_INTERSECTIONS	Yes	None
jobName	The name of the job to be used. This job name appears on the job console. Example: ExportVIRecords	No	Export Valid Intersections
fileName	The name of the ZIP file that will be created to hold the Excel file containing valid intersection records. The file containing the exported data is stored in the Outbox.	Yes	None
names	If provided, exports some of the records using the names in a comma-separated list of valid intersection record names. For example, the list could contain VIAccountPeriod,VIEntityPeriod,VIProductPeriod . If this parameter is not provided, all valid intersection records are exported.	No	All records are exported

For a sample URL, see the sample URL and payload in Execute a Job

Sample Payload

Example 1: Exports all valid intersections records to the file ExportVIRecordsFile.zip.

{
    "jobType": "Export Valid Intersections",
    "jobName": "ExportVIJob",
    "parameters": {
        "fileName": "ExportVIRecordsFile.zip"
    }
}

Example 2: Exports three valid intersection records with names VIAccountPeriod, VIEntityPeriod, and VIProductPeriod to the file Export3VIRecordsFile.zip.

{
    "jobType": "Export Valid Intersections",
    "jobName": "ExportVIJob",
    "parameters": {
        "fileName": "Export3VIRecordsFile.zip",
        "names": "VIAccountPeriod,VIEntityPeriod,VIProductPeriod"
    }
}