Value List Items
Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
Related guide: Managing list items
The Value List Item object
Attributes
- idstring
Unique identifier for the object.
- valuestring
The value of the item.
- value_
liststring The identifier of the value list this item belongs to.
More attributes
- objectstring
- createdtimestamp
- created_
bystring - livemodeboolean
Create a value list item
Creates a new ValueListItem object, which is added to the specified parent value list.
Parameters
- valuestringRequired
The value of the item (whose type must match the type of the parent value list).
- value_
liststringRequired The identifier of the value list which the created item will be added to.
Returns
Returns a ValueListItem object if creation succeeds.
Retrieve a value list item
Retrieves a ValueListItem object.
Parameters
No parameters.
Returns
Returns a ValueListItem object if a valid identifier was provided.
List all value list items
Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- value_
liststringRequired Identifier for the parent value list this item belongs to.
- valuestring
Return items belonging to the parent list whose value matches the specified value (using an “is like” match).
More parameters
- createddictionary
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit items, starting after item starting_after. Each entry in the array is a separate ValueListItem object. If no more items are available, the resulting array will be empty.