trigger.update
説明
object trigger.update(object/array triggers)
このメソッドは、既存のトリガーを更新するためのものです。
このメソッドは管理者およびスーパ管理者ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object/array) 更新するトリガーのプロパティ。
各トリガーでは triggerid プロパティを定義する必要があり、その他の
プロパティはすべて任意です。渡されたプロパティのみが更新され、その他
は変更されません。
標準のトリガープロパティ に加えて、この メソッドは以下のパラメータを受け付けます。
| Parameter | Type | Description |
|---|---|---|
| dependencies | array | トリガーが依存している トリガー。 トリガーでは triggerid プロパティのみを定義する必要があります。 |
| tags | array | トリガータグ。 |
戻り値
(object) triggerids プロパティの下で更新されたトリガーの ID を含むオブジェクトを返します。
例
トリガーの有効化
トリガーを有効にします。つまり、ステータスを "0" に設定します。
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "13938",
"status": 0
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}トリガータグの置換
トリガーのタグを置換します。
{
"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
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}依存関係の置き換え
トリガーの依存関係を置き換えます。
{
"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
}ソース
CTrigger::update() in ui/include/classes/api/services/CTrigger.php.