Web API Reference Guide > Available API Methods > Job Queue Methods > The jobqueueDeleteJobsByPredefinedFilter Method

The jobqueueDeleteJobsByPredefinedFilter Method

Delete job queue jobs according to a filter.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
filterName	String	No	A predefined filter's name. This parameter is case-sensitive.
filter	Array	No	Associative array, accepts any of the following keys: app_id, name, script, priority, status, rule_id, scheduled_before, scheduled_after, executed_before, executed_after, freeText The priority key, accepts the following values: low, normal, high, urgent. The status key, accepts the following values: Active, Waiting, Running, Completed, Failed, Timeout, Removed, Scheduled, Suspended

Expected Response Code: 200 OK - Returned for successfully deleting the jobs according to the filter passed.

Possible Action Specific Error Codes: No specific error codes exist for this action.

Example

Usage Example

Request

POST /ZendServer/Api/jobqueueDeleteJobsByPredefinedFilter

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
	<method>jobqueueDeleteJobsByPredefinedFilter</method>
	</requestData>
	<responseData>
	</responseData>
<zendServerAPIResponse>

	Read Also
	Available API Methods
	Job Queue Methods