The jobqueueDisableRules Web API Method

Suspend a job queue rule.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
rules	Array	Yes	A list of rule IDs.

Expected Response Code: 200 OK - Returned for successfully suspending a list of rules according to the provided parameters. For more information see Response Format.

Possible Action Specific Error Codes: None.

Example

Usage Example

Request

POST /ZendServer/Api/jobqueueDisableRules
rulkes[]=1&rulkes[]=2

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>jobqueueDisableRules</method>
	</requestData>
	<responseData>
		<rules>
			<rule>
				<id>1</id>
				<type>absolute</type>
				<queueName>default</queueName>
				<status>suspended</status>
				<priority>normal</priority>
				<persistent>No</persistent>
				<script><![CDATA[http://url/of/job1]]></script>
				<name><![CDATA[myqueue]]></name>
				<vars></vars>
				<http_headers></http_headers>
				<appId></appId>
				<lastRun></lastRun>
				<nextRun></nextRun>
			</rule>
 			<rule>
				<id>2</id>
				<type>absolute</type>
				<queueName>default</queueName>
				<status>suspended</status>
				<priority>normal</priority>
				<persistent>No</persistent>
				<script><![CDATA[http://url/of/job2]]></script>
				<name><![CDATA[myqueue]]></name>
				<vars></vars>
				<http_headers></http_headers>
				<appId></appId>
				<lastRun></lastRun>
				<nextRun></nextRun>
			</rule>
		</rules>
		<total>2</total>
	</responseData>
<zendServerAPIResponse>