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

Method GetCheckListItem

API

Gets CheckList Item value

Watch this video to learn how to use this method

Have a problem with playback?
GetChecklistItem returns checklist item value The inputs for the method are path of the checklist item and optional position number if checklist contains more then one item with the same path (starting from 0) if position number not provided it sets to 0 by default Let's see CreateBooks API method We can see there are 4 records in the checklist We will use GetCheckListItem along with messagebox to read and output value "Book2" during runtime. So the path should be CreateBooksResult and number is 2 Run the script and we can see the message box shows "Book2" as we expected

Usage

Function GetCheckListItem(
    String Path,
    Integer Position [Optional]
)

GetBookById

GetChe...Item

Title

0

Path

Position [Optional]

Parameters

Path

Type: String

The path of the CheckList Item

Position (optional)

Type: Integer

Position if CheckList contains few item names

Returns

CheckList Item value or Empty string

Example

VBScript

msgbox Server("API Server").Method("GetBookById").GetCheckListItem("Title")
' set position
msgbox Server("API Server").Method("GetBookById").GetCheckListItem("Title", 0)

JavaScript

alert(Server("API Server").Method("GetBookById").GetCheckListItem("Title"));
// set position
alert(Server("API Server").Method("GetBookById").GetCheckListItem("Title", 0));

Variable

title

GetCheckListItem

Title

Method

Zap.Comm...Box

Zap.Var...("title")

Contact Us

Tower Place 100

3340 Peachtree Rd NE #1800 

Atlanta, GA 30326 USA

(404) 814-5227