LinkedIn
Copied!

Refresh UI action in DX API

The Refresh action reloads a part of the UI when a specified event occurs (for example, when a user clicks a button). Learn about the JSON structure and elements of a sample Refresh action, to understand how you can integrate it into your custom application.

The following JSON code is a sample API response for the Refresh action with a data transform and an activity:

{"actionSets": [
    {
        "actions": [
            {
                "action": "refresh",
                "refreshFor": "cHlUZW1wbGF0ZUJ1dHRvbiNweEJ1dHRvbiMxNmNjNmYwMS01MjNhLTQ5NTMtYjFhYy04NmIzMzc5%0AMzQwZmI%3D"
            }
        ],
        "events": [
            {
                "event": "click"
            }
        ]
    }
]
}

A Refresh action with a data transform and an activity
A Refresh action with a data transform and an activity

An action set that is configured to refresh a section will always return the refreshFor element, which refreshes the section, in the JSON response. The refreshFor element functions as the ID in the following API endpoint that initiates the data transform or activity configured in the action set: /assignments/{assignmentID}/actions/{actionID}/refresh?refreshFor={refreshForID}.

  • DX API v1 does not support the following actions:
    • Refresh-Current Harness
    • Refresh-Other Section

    The JSON response returns the value for the refreshFor element but the API endpoint does not initiate the data transform or activity configured in the action set.

  • DX API v1 does not support the Disable submit on refresh check box and the when conditions in the action set.

 

Suggest Edit
Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.