Method GetArrayResponse

Returns data array of entire or partial API response by the given path

Usage

Function GetArrayResponse(
    String Path [Optional],
    Boolean Report [Optional]
)

Method

ZAP API Method step

GetArray...ponse

[0].Awards

True

String Path [Optional]

Boolean Report [Optional]

Output Parameter

Parameters

Path (optional)

Type: String

Default Value: Empty String

Path to the object: User[5].Information.Awards

Report (optional)

Type: Boolean

Default Value: False

Generate report for this step

Returns

Array

Example

VBScript

Server("API Server").Method("GetUsers").Execute
msgbox Server("API Server").Method("GetUsers").GetArrayResponse("[0].Awards", True)

JavaScript

Server("API Server").Method("GetUsers").Execute();
alert(Server("API Server").Method("GetUsers").GetArrayResponse("[0].Awards", true));

GetUsers

ZAP API Method step

Execute

Script-Less next step

Variable

awards

ZAP API Method step

GetArray...ponse

[0].Awards

True

Script-Less next step

GetUsers

ZAP Utility step

Zap.Comm...Box

Zap.Var...("awards")