job_queue_cycle
Overview
Runs through the scheduler cleanup process and cycles the scheduler jobs.
Available APIs
Definition
job_queue_cycle(session, clientid)
Parameters
| Name |
Type |
Description |
|---|
| session |
String |
Session ID returned by a previous login call. |
| clientid |
String |
The client id calling the application. This parameter is of your choosing for the calling application. |
Result
| Name |
Type |
Description |
|---|
| result |
Array |
The call result. |
| result.results |
String |
The cycle result. Returns 'ok' on success. |
Change Log
| Version |
Change |
|---|
| v4 |
Added job_queue_cycle method. |
Examples
PHP
$job_queue_cycle_parameters = array(
//Session id
'session' => $session_id,
//The ID of the calling application.
'clientid' => 'MyAppID',
);