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