MENU
    Refresh Preloaded Data API
    • 1 Minute to read
    • Dark
    • PDF

    Refresh Preloaded Data API

    • Dark
    • PDF

    Article summary

    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”: “xyz@planful.com”,
    “Password”: “Ayz@123”,
    “TenantCode”: “Apr2021Demo”,
    “ClientType”: “ExcelAddin”
    }
    Shell

    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>

    Note:
    You can find the Source Code from the Scenario Setup screen.

    Headers

    Key : APIKey

    Value : Authorization Key

    Response

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

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


    Was this article helpful?