The codetracingList Web API Method

Retrieve a list of code-tracing files available for download using codetracingDownloadTraceFile.

Version: 1.1

Required Permissions: Full

HTTP method: GET

Supported Editions: Zend Server

Request parameters:

Parameter

 Type

Required

Description

applications

Array

No

List of application IDs. If specified, code-tracing entries will be returned for these applications only. Default: all applications

freetext*

String

No

If specified, code-tracing entries will be returned based on URL or ID

type*

integer

No

0: Triggered by Code

1: Triggered by Event

2: Manual request

3: Triggered by segmentation fault

Defaults to -1: All types

limit

Integer

No

 

Row limit to retrieve, defaults to value defined in zend-user-user.ini

offset

Integer

No

 

The page offset to be displayed, defaults to 0

orderBy

String

No

 

Column to sort the result by (Id, Date, Url, CreatedBy, Filesize), defaults to Date

direction

String

No

 

Sorting direction , defaults to Desc

*Added in 1.3

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

Response Format: Response successful message or error message

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request

GET /ZendServer/Api/codetracingIsEnabled

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>codetracingList</method>
	</requestData>
	<responseData>
		<codeTracingTotalCount>28</codeTracingTotalCount>
			<codeTracingList>
				<codeTrace>
					<id>1.256.3</id>
					<date>123412341234</date>
					<url>http://localhost/test.php</url>
					<createdBy>Monitor Event</createdBy>
					<fileSize>12341234</fileSize>
					<applicationId>1</applicationId>
					<nodeId>0</nodeId>
				</codeTrace>
				<codeTrace>
					<id>1.256.3</id>
					<date>123412341234</date>
					<url>http://localhost/test.php</url>
					<createdBy>Manual Request</createdBy>
					<fileSize>12341234</fileSize>
					<applicationId>2</applicationId>
					<nodeId>0</nodeId>
				</codeTrace>
			</codeTracingList>
	</responseData>
<zendServerAPIResponse>