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],
    Boolean Report [Optional]
)

GetBookById

ZAP Object step

GetChe...Item

Title

0

True

title

Path

Position [Optional]

Report

Output Parameter

Parameters

Path

Type: String

The path of the CheckList Item

Position (optional)

Type: Integer

Position if CheckList contains few item names

Report (optional)

Type: Boolean

Default Value: False

Generate report for this step

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, True)

JavaScript

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

Step

ZAP Object step

GetCheckListItem

Title

title

Script-Less next step

Method

ZAP Utility step

Zap.Comm...Box

Zap.Var...("title")

Contact Us

1425 Market Blvd Suite 530-230

Roswell, GA 30076, USA

(800) 795-3552