WebAPI Reference Guide > Available API Methods > Job Queue Methods > The jobqueueSaveRule Method

The jobqueueSaveRule Method

Create a job queue rule.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
url	Array	Yes	A URL for the job.
vars	Array	No	Variables for the rule.
options	Array	Yes	Rule options.

Expected Response Code: 200 OK - Returned for successfully creating the rule 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: None.

Example

	Request POST /ZendServer/Api/jobqueueSaveRule url=http%3A%2F%2Fmyhost%2Fmyjob.php&options[schedule]=***** Response <?xml version="1.0" encoding="UTF-8"?> <zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3"> <requestData> <apiKeyName><![CDATA[Admin]]></apiKeyName> <method>jobqueueSaveRule</method> </requestData> <responseData> <rules> <rule> <id>1</id> <type>absolute</type> <queueName>default</queueName> <status>deleted</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>

	Related Links: Available API Methods