The monitorGetIssueEventGroups Web API Method

Retrieve an issue's Event Groups with a pagination option.

Version: 1.2

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

issueId

String

Yes

The predefined filter's id. Can be the filter's “name” or the actual identifier randomly created by the system. This parameter is case-sensitive.

limit

Integer

No

Limits the number of eventsGroups returned with the issue details, default is 0 which places no limit.

offset

Integer

 

No

 

Offsets the returned dataset to allow for pagination of data.

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: Response successful message or error message

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

404

noSuchIssue

The requested issue does not exist

Example

Usage Example

Request

GET /ZendServer/Api/monitorGetIssueEventGroups?issueId=1&limit=3&offset=3

Content-type: application/x-www-form-urlencoded

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>monitorGetIssueDetails</method>

</requestData>

<responseData>

<eventsGroups>

<eventsGroup>

<eventsGroupId>134</eventsGroupId>

<eventsCount>1</eventsCount>

<startTime>20-Sep-2011 18:45</startTime>

<serverId>0</serverId>

<class></class>

<userData><![CDATA[]]></class>

<javaBacktrace><![CDATA[]]><javaBacktrace>

<execTime>0</execTime>

<avgExecTime>0</avgExecTime>

<memUsage>0</memUsage>

<avgMemUsage>0</avgMemUsage>

<avgOutputSize>0</avgOutputSize>

<load>0</load>

</eventsGroup>

</eventsGroups>

<totalCount>1</totalCount>

</responseData>

</zendServerAPIResponse>