trigger.update
Description
object trigger.update(object/array triggers)
This method allows to update existing triggers.
This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.
Parameters
(object/array) Trigger properties to be updated.
The triggerid property must be defined for each trigger, all other
properties are optional. Only the passed properties will be updated, all
others will remain unchanged.
Additionally to the standard trigger properties the method accepts the following parameters.
| Parameter | Type | Description |
|---|---|---|
| dependencies | array | Triggers that the trigger is dependent on. The triggers must have only the triggerid property defined. |
| tags | array | Trigger tags. |
Return values
(object) Returns an object containing the IDs of the updated triggers
under the triggerids property.
Examples
Enabling a trigger
Enable a trigger, that is, set its status to "0".
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "13938",
"status": 0
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}Replacing triggers tags
Replace tags for trigger.
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "13938",
"tags": [
{
"tag": "service",
"value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
},
{
"tag": "error",
"value": ""
}
]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}Replacing dependencies
Replace dependencies for trigger.
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "22713",
"dependencies": [
{
"triggerid": "22712"
},
{
"triggerid": "22772"
}
]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"22713"
]
},
"id": 1
}Source
CTrigger::update() in ui/include/classes/api/services/CTrigger.php.