Web API Reference Guide > Available API Methods > Codetracing Methods > The codetracingDownloadTraceFile Method

The codetracingDownloadTraceFile Method

Download the amf file specified by the codetracing identifier.

Version: 1.2

Required Permissions: Full

HTTP method: GET

Supported Editions: Zend Server

Request parameters:

Parameter	Type	Required	Description
traceFile	String	Yes	Trace file identifier.
eventsGroupId*	Integer	No	EventsGroupId associated with the tracefile. This parameter can serve instead of the traceFile parameter

*Added in 1.3

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

Response Format:

A successful call to the monitorDownloadAmf method will result in an HTTP response with the amf file in the response body.

The content type for the amf file is “application/x-amf”. In addition, the response will include a “Content-disposition” header specifying a suggested file name for the file.

This is different from most Web API calls where the content type is expected to be “application/vnd.zend.serverpi+xml; version=…” and the response body payload is expected to be in XML format.

In case of error, a regular error response will be returned, containing an <errorData> element as defined for other Web API methods.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
404	noSuchTrace	The requested trace could not be found
404	noSuchEventGroup	The requested event group id could not be found to use for retrieving the trace file

Example

Usage Example

Request (headers removed for the purpose of clarity)

GET /ZendServer/Api/codetracingDownloadTraceFile?traceFile=10.123.4

Response (not all headers are shown)

HTTP/1.0 200 OK
Content-type: application/x-amf
Content-disposition: attachment; 
  filename=”10.123.4.amf”
[...binary data follows...]

	Read Also
	Available API Methods
	Codetracing Methods