Job Schedulers API
Table of Contents
TimeBasedAlerts Job Scheduler
This scheduler is in charge of the configuration of the different cron jobs related to TimeBasedAlerts.
Current Implementation
The only supported operation, right now, is to re-schedule all the alerts for a particular Organization or for all of them. The configuration of the alerts must still be performed manually in the database.
This operation is depends on the following 2 permissions: 're_schedule_alerts_from_all_organizations' and 're_schedule_alerts_from_organization'.
Parameters
Base URL: /timeBasedAlertsJobScheduler
Name | Type | Mandatory | Description |
---|---|---|---|
token | String | Yes | Security Token obtained before. |
userId | String | Yes | The id of the logged in user. |
action | ENUM | Yes | Possible values: ['RE_SCHEDULE']. The action to be performed. |
location | ENUM | No | Possible values: ['ALL_ORGANIZATIONS', 'ORGANIZATION'] |
locationId | String | No (if 'location' == 'ORGANIZATION', then this parameter is mandatory) | The id of the location. |
API Sample
Happy Scenario
Result
{"statusFact":{"success":true}}
Not Enough Privileges Scenario
Result
{"statusFact":{"failMessage":"Not enough privileges!","success":false}}