The jobqueueDeleteQueue Web API Method

Deletes a queue from a queues list.

Version: 1.10

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

id

Integer

Yes

The ID of the queue.

delete_related_stuff

Integer

No

0 or 1. default 0. Delete related rules and future jobs (pending, sheduled and suspended)

Expected Response Code: 200 OK - Returned for a successful request.

Possible Action Specific Error Codes: None.

Example

Usage Example

Request

POST /ZendServer/Api/jobqueueDeleteQueue
id=213

Response

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.10">
	<requestData>
		<apiKeyName>
			<![CDATA[admin]]>
		</apiKeyName>
		<method>jobqueueDeleteQueue</method>
	</requestData>
	<responseData>
		<result>success</result>
	</responseData>
</zendServerAPIResponse>