The studioStartDebug Web API Method

Start a debug session for a specific issue.

Version: 1.2

Required Permissions: Full

HTTP method: POST

Supported Editions: Zend Server

Request parameters:

Parameter

 Type

Required

Description

eventsGroupId

String

Yes

The issue event group identifier

noRemote

Boolean

No

Use server's own local files for debug display. Default: true. Setting to false will use local files from studio if available

overrideHost

String

No

Override the host address sent to Zend Server for initiating a Debug session. This is used to point Zend Server at the right address where Studio is executed

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

POST /ZendServer/Api/studioStartDebug
Content-type: application/x-www-form-urlencoded
eventsGroupId=36

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>studioStartDebug</method>
	</requestData>
	<responseData>
		<debugRequest>
			<success>1</success>
			<message>Debug session completed successfully</message>
		</debugRequest>
	</responseData>
</zendServerAPIResponse>