The jobqueueDeleteJobs Web API Method

Delete job queue.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
jobs	Array	Yes	A list of Job IDs

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

Response Format: A list of jobs, their dependent information and a total count of records for the provided filter

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	internalServerError	Retrieving a list of jobs failed due to an internal problem

Example

Usage Example

Request

GET /ZendServer/Api/jobqueueJobsList

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>jobqueueDeleteJobs</method>
	</requestData>
	<responseData>
		<jobs>
			<job>
				<id>1</id>	
				<type>absolute</type>
				<nodeId>5</nodeId>
				<queueName>default</queueName>
				<status>removed</status>
				<priority>normal</priority>
				<persistent>No</persistent>
				<script><![CDATA[http://url/of/job]]></script>
				<name><![CDATA[myqueue]]></name>
				<creationTime></creationTime>
				<startTime></startTime>
				<endTime></endTime>
				<schedule></schedule>
				<scheduleTime></scheduleTime>
				<scheduleId></scheduleId>
			</job>	
			<job>
				<id>2</id>
				<type>absolute</type>
				<nodeId>5</nodeId>
				<queueName>default</queueName>
				<status>removed</status>
				<priority>normal</priority>
				<persistent>No</persistent>
				<script><![CDATA[http://url/of/job]]></script>
				<name><![CDATA[myqueue]]></name>
				<creationTime></creationTime>
				<startTime></startTime>	
				<endTime></endTime>
				<schedule></schedule>
				<scheduleTime></scheduleTime>
				<scheduleId></scheduleId>
			<job>
		</jobs>
		<total>2</total>
	</responseData>
<zendServerAPIResponse>