The jobqueueJobInfo Web API Method

Retrieve and display a list of jobs.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
id	Integer	Yes	ID of the job.

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/jobqueueJobInfo

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>jobqueueJobDetails</method>
	</requestData>
	<responseData>
		<jobInfo>
			<job>
				<id>1</id>
				<type>absolute</type>
				<nodeId>5</nodeId>
				<queueName>default</queueName>
				<status>ok</status>
				<priority>normal</priority>
				<persistent>No</persistent>
				<script><![CDATA[http://url/of/job]]></script>
				<name><![CDATA[myqueue]]></name>
				<creationTime></creationTime>
				<creationTimeTimestamp></creationTimeTimestamp>
				<startTime></startTime>
				<startTimeTimestamp></startTimeTimestamp>
				<endTime></endTime>
				<endTimeTimestamp></endTimeTimestamp>
				<schedule></schedule>
				<scheduleTime></scheduleTime>
				<scheduleTimeTimestamp></scheduleTimeTimestamp>
				<scheduleId></scheduleId>
				<applicationId></applicationId>
				<application></application>	
			</job>
			<jobDetails>
				<jobId>1</jobId>
				<vars><![CDATA[{}]]></vars>
				<output><![CDATA[]]></output>
				<httpHeaders><![CDATA[]]></httpHeaders>
				<error><![CDATA[]]></error>
			</jobDetails>
		</jobInfo>
	</responseData>
<zendServerAPIResponse>