Execute a Report Bursting Definition

You can execute bursting for a single report or book for more than one member of a single dimension, and publish a PDF or Excel output for each member.

The bursting definition must be present in the folder that you specify with the burstingDefinitionName parameter.

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-35 Execute a Report Bursting Definition

Name	Description	Required	Default
jobType	Execute Bursting Definition or EXECUTE_MR_BURST (both parameters are supported)	Yes	None
jobName	The name of the job to be used. This job name appears on the job console. Example: MonthlySalesBurstDev	No	Execute Bursting Definition
burstingDefinitionName	Bursting definition name with the complete path to where the bursting definition is stored. Example: /Library/Jan/MonthlySalesBurstDef	Yes	None

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

Sample Payload

Example 1: Executes the bursting definition named MonthlySalesBurstDev that is present in the Library folder.

{
  "jobType":"Execute Bursting Definition",
  "jobName":"Execute MonthlySalesBurstDef",
  "parameters": {
    "burstingDefinitionName":"Library/MonthlySalesBurstDef"
  }
}

Example 2: Executes the bursting definition named MonthlySalesBurstDev that is present in the Reports subfolder under the Library folder.

{
  "jobType":"Execute Bursting Definition",
  "jobName":"Execute MonthlySalesBurstDef",
  "parameters": {
    "burstingDefinitionName":"Library/Reports/MonthlySalesBurstDef"
}