The jobqueueKillJobs Web API Method

Use this method to stop or interrupt job queue jobs.

Version: 1.15

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

jobs

Array

Yes

The list of job IDs to cancel.

reason

String

Yes

 

Expected Response Code: 200 OK - Returned for a successful request.

Possible Action Specific Error Codes: None.

Example

Usage Example

Request

POST /ZendServer/Api/jobqueueKillJobs
jobs=213&reason=""

Response

{
    "jobs": [
        {
            "id": 47,
            "type": 2,
            "nodeId": 0,
            "nodeName": "",
            "retries": [],
            "queueId": 1,
            "queueName": "Default",
            "queueStatus": "1",
            "status": "16",
            "priority": 1,
            "priority_ui": "",
            "persistent": false,
            "script": "/var/www/html/jobs/very_long_job.php",
            "error": "",
            "retriesCount": 0,
            "name": "very_long_job",
            "validate_ssl": "",
            "start_or_schedule_time": "2018-02-27T14:31:54+02:00",
            "schedule_cron_to_human": "Every hour",
            "creationTime": "2018-02-27T14:31:51+02:00",
            "creationTimeTimestamp": 1519734711,
            "startTime": "2018-02-27T14:31:54+02:00",
            "startTimeTimestamp": 1519734714000,
            "endTime": "",
            "endTimeTimestamp": "",
            "schedule": "H 1",
            "scheduleTime": "2018-02-27T14:31:54+02:00",
            "scheduleTimeTimestamp": 1519734714,
            "scheduleId": "",
            "applicationId": -1,
            "application": ""
        }
    ],
    "failed": [],
    "total": 1
}