Managing Multiple Alerts¶

You can use the following REST APIs to modify, pause, resume, restart, and delete multiple alerts:

• Modifying Multiple Alerts
• Pausing Multiple Alerts
• Resuming Multiple Alerts
• Restarting Multiple Alerts
• Deleting Multiple Alerts

Modifying Multiple Alerts¶

Contrary to REST conventions, the alert service uses the PUT method to create an alert and the POST method to modify multiple alerts. Typical user cannot modify the alert of another user but the system admin (superuser) can modify the alert of all users. Organization admin (jasperadmin) can modify only if the users and jasperadmin belong to the same organization. To modify an existing alert definition, use the GET method to read its alert descriptor, modify the desired properties, then use the following POST method:

The following is an example of the request body for updating multiple alerts in JSON:

{
    "label":"Modified label",
    "isDescriptionModified":true,
    "triggerModel":{
    "simpleTriggerModel":{
            "timezone":"Europe/Helsinki",
        }
    }
    "baseOutputFilename":"Lalala"
}

The following is an example of the response body for the list of updated alert IDs in JSON:

{"alertId":[5594,5645]}

Pausing Multiple Alerts¶

The following method pauses currently scheduled alert execution, also called as disabled in the user interface. Pausing keeps the alert schedule and all other details but prevents the alert from running. It does not delete the alert.

The request and the response have the same format, an array, or list of alertId elements:

{
    "alertsId": [
        5805
    ]
}

Resuming Multiple Alerts¶

Use the following method to resume all paused alerts. On the resume of an alert any defined trigger that occurs after the time it is resumed causes the report to run again. Missed triggers that occur before the alert is resumed are never run.

The request and the response have the same format, an array, or list of alertId elements:

{
    "alertsId": [
        5805
    ]
}

Restarting Multiple Alerts¶

Use the following method to rerun failed alerts. For each alert to be restarted, this method creates an immediate single-run copy of the alert, to replace the one that failed. Therefore, all alerts listed in the request body run once immediately after issuing this command. The single-run copies have a misfire policy set so that they do not trigger any further failures (MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY). If the single-run copies fail themselves, no further attempts are made automatically.

The request and the response have the same format, an array, or list of alertId elements:

{
    "alertsId": [
        5805
    ]
}

Deleting Multiple Alerts¶

Use the DELETE method to remove multiple alerts from the report. The below form deletes multiple alerts.

The following is an example of the request body for deleting an alert in JSON:

{
    "alertsId": [
        5330,
        5350
    ]
}

The following is an example of the response body for deleting an alert in JSON:

{
    "alertsId": [
        5330,
        5350
    ]
}