Clear Data (Master and Analytic Models)

Clear Data (Master and Analytic Models)

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

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

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

• To clear all model 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/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 data will be cleared

2. $Dimension: (type: string) Name of the dimension in which 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

Response

Success Response

HTTP/1.1 200/204 OK

Error Responses

Service Not Available (possibly due to maintenance)

HTTP/1.1 503 Service Unavailable

One or more HTTP headers were missing

HTTP/1.1 412 Precondition Failed

Unauthorized Access (access key lookup failed)

HTTP/1.1 401 Unauthorized

Invalid XML (bad request)

HTTP/1.1 400 Bad Request

Not Found (source model not found)

HTTP/1.1 404 Not Found