set, checklist, check, list, item, api, request, response, send, soap, rest, get, post, put, delete

Method SetCheckListItem

API

Sets CheckList Item value

Watch this video to learn how to use this method

Have a problem with playback?
SetCheckListItem sets API request checklist during the runtime The input parameters are String path and string value, there is also optional boolean overwrite which should be True if we want to keep single checklist record or False to add a new item to the collection. By default it is True Let's use ConcatArrayData API method for demonstartion purposes. We can see one record in the checklist Let's ad another one for the script runtime We set path as "new path" and value as "555", overwrite option should be False we will set a breakpoint then to pause the script during runtime Run and we can see new record appears in the checklist.

Usage

Function SetCheckListItem(
    String Path,
    String Value,
    Boolean Overwrite [Optional]
)

GetBookById

SetCheckListItem

Author

Unknown

True

Path

Value

Overwrite

Parameters

Path

Type: String

The path of the CheckList Item

Value

Type: String

The new value to set (must be a string)

Overwrite (optional)

Type: Boolean

Default Value: True

True if keep only single Checklist Item name in a list, False to add a new item in a collection

Returns

No return value

Example

VBScript

Server("API Server").Method("GetBookById").SetCheckListItem "Author", "Unknown", True

JavaScript

Server("API Server").Method("GetBookById").SetCheckListItem("Author", "Unknown", true);

GetBookById

SetCheckListItem

Author

Unknown

True

Contact Us

Tower Place 100

3340 Peachtree Rd NE #1800 

Atlanta, GA 30326 USA

(404) 814-5227