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

The jobqueueRulesList Method

Retrieve and display a list of jobs rules.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

limit

Integer

No

Row limit to retrieve, defaults to value defined in zend-user-user.ini

offset

Integer

No

The page offset to be displayed, defaults to 0

orderBy

String

No

Column to sort the result by (), defaults to Date

direction

String

No

Sorting direction , defaults to Desc

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 job rules failed due to an internal problem

Example

Usage Example

Request

GET /ZendServerManager/Api/jobqueueRulesList

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>jobqueueRulesList</method>

</requestData>

<responseData>

<rules>

<rule>

<id>1</id>

<type>absolute</type>

<queueName>default</queueName>

<status>ok</status>

<priority>normal</priority>

<persistent>No</persistent>

<script><![CDATA[http://url/of/job]]></script>

<name><![CDATA[myqueue]]></name>

<vars></vars>

<http_headers></http_headers>

<appId></appId>

<lastRun></lastRun>

<nextRun></nextRun>

<rule>

</rules>

</responseData>

<zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Job Queue Methods