Clear Leaf Data (Master and Analytic Models)

This API clears existing leaf data from Master and Analytic models based on the scope of the definition. Clear Leaf Data API results in a success even if all data has been cleared in an earlier call.

You can opt to clear specific leaf data versus the entire model.

• To clear specific leaf data, you will use filters. For example, you might opt to clear leaf data for a specific period, department, or company.

• To clear all model leaf data, you will use the API without filters.

You can receive a notification via email upon success or failure of the operation. The notifications for success and failure are separate and can be emailed to different email addresses, if desired. This notification is optional.

POST /modeling/model/data/leaf/clear HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:
 
<?xml version="1.0" encoding="UTF-8"?>
<clear-data-payload>
 	<model-name>$ModelName</model-name>
<filters>
<filter>
<dimension>$Dimension/dimension>
<filter-type>$FilterType</filter-type>
<filter-value>$FilterValue1</filter-value>
<filter-value>$FilterValue2</filter-value>
<filter-value>$FilterValue3</filter-value>
	  …

</filter>
	…
</filters>
<notify-on-success>
<email>$EmailAddress</email>
</notify-on-success>
<notify-on-failure>
<email>$EmailAddress</email>
</notify-on-failure>
</clear-data-payload>

Parameters

1. $ModelName: (type: string) Name of the model in which leaf data will be cleared

2. $Dimension: (type: string) Name of the dimension in which leaf data will be cleared

3. $FilterType: (type: string) Dimension filter type

4. $FilterValue: (type: string) Value of the filter

5. $EmailAddress: (type: string) Valid email address to receive the notification

Payload Sample to Clear All Leaf Data

POST /modeling/model/data/leaf/clear HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:
 
<?xml version="1.0" encoding="UTF-8"?>
<clear-data-payload>
<model-name>ClearModelTest</model-name>
<filters>
<filter>
<dimension>Measures</dimension>
<filter-type>FixedMember</filter-type>
<filter-value>MTD</filter-value>
<filter-value>YTD</filter-value>
</filter>
<filter>
<dimension>Scenario</dimension>
<filter-type>FixedMember</filter-type>
<filter-value>Actual</filter-value>
<filter-value>Budget</filter-value>
</filter>
</filters>
<notify-on-success>
<email>john.doe@mycompany.com</email>
</notify-on-success>
<notify-on-failure>
<email>john.doe@mycompany.com</email>
</notify-on-failure>
</clear-data-payload>