The jobqueueSaveRule Web API Method

Create or modify 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

No*

A URL for the job.

ruleId

Integer

No*

The ID of the rule. If supplied, the existing rule will be updated

vars

Array

No*

Variables for the rule, passed to the ZendJobQueue API.

options

Array

Yes

Rule options, passed to the ZendJobQueue API.

Note:

*Details about the options and vars parameters can be found in the Zend Job Queue PHP API reference. For all intents and purposes, they are identical.

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

Usage 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>