Refresh Preloaded Data API

The Refresh Preloaded Data API updates the Preload Budget Scenario with the data from the reference Scenario or the CC data based on the Scenario setup.

You have to generate the APIKey first to use the API. You can pass the following information to generate the APIKey.

Method

POST

Syntax

<Provide the Application Url>/auth/login

Sample Body

{
“Username”: “benbradley@planful.com”,
“Password”: “password”,
“TenantCode”: “Apr2021Demo”,
“ClientType”: “ExcelAddin”
}

When you run this, an authorization key is generated. Use this key as the APIKey to refresh the preload budget scenario.

Do the following to refresh the preload budget scenario:

Method

POST

Syntax

<Provide the Application Url>/Scenario/RefreshPreloadedData?scenarioCode=<provide the scenario code>

Headers

Key : APIKey

Value : Authorization Key

Response

{
“status”: “Success”,
“message”: “Refresh Preload Budget data completed successfully”
}

The API refreshes the data and displays an appropriate successful message.