The Quick Data API can be used for making changes to data in objects without the complexity of managing JSON objects. The purpose of this API is to automate adding data that is used in stack item evaluation.
Data can be sent as a URL encoded form post or as query parameters in the URL.
Quickly updating data for selectively displaying items
For example, to only display an advert for a coat when it is cold and wet an item may be constructed with the following condition:
temp < 15 && weather == "rain"
To populate the required data to display / hide the item the following quick data API request could be made by an external system that monitors the weather:
This sets the data named
temp to the value 10 and the data named
weather to the value
rain in the screen with the ID
This would result in the item being able to display.
Data can also be set it other objects in the system. For example in a sequence:
Sets the data named
offer to the value
1 in the sequence with the ID
Quickly changing screen configuration
The Quick Data API can be used to make data changes that are not part of stack item evaluation. For example, quickly changing the sequence being displayed or updating scrolling text on a screen. Changes take effect instantly.
Display the sequence with ID
1234567ABCDEF on the screen with the ID
Display the scrolling text HelloWorld! on the screen with the ID
Set the data named
label to the value
Joe Bloggs in the user with the ID
To remove data from an object, provide the name and equals with no value.
Remove the data named
scrollingText from the screen with the ID
To modify data in a group of screens in a single request.
Overrides the time zone of all screens in the group named
group-screen-data endpoint is for updating data for multiple screens and does not return data. The response body will be
OK if successful.
Java Code Examples
Some examples demonstrating how to use the quick data API in a Java application: