It allows you to control the items from a Dynamic List. This action moves the list index to its first item. When it reaches the last step, further calls to this endpoint will have no effect.
To control cycling items within a dynamic list via API, follow the steps below.
To activate the Integration ID within the dynamic list, it is necessary to use the pagination filter within the list.
To know more about pagination filter, click here.
1. Generate your graphics token
Learn how to generate your token here.
2. Getting the Overlay Identifier
To take the Overlay ID:
In the tree select the overlay.
Take the node number from the URL on your web browser (This is the Overlay Identifier).
3. Assign a Control Id
From the graphics editor you need to generate an API identifier for Dynamic List, just follow these steps.
Select the Dynamic List from your graphics tree.
On the inspector, click on Cycle Control, in Integration ID field add an identifier for this list.
Variables
KEY | DESCRIPTION |
|
TOKEN-GRAPHICS | It is the identifier of your graphic package. | String
|
OVERLAY ID | It is the identifier of the overlay. | String e.g. "id:n7" |
CONTROL ID | It is the identifier of your Dynamic List that you want to control. | String e.g. "listcontrol" |
You can go to the beginning of the list ("goto-first" action), forward ("goto-next" action), or back ("goto-prev" action) one step.
To find all you need to know about the List API please refer to the complete API documentation available here.