triggerprototype.update

説明

object triggerprototype.update(object/array triggerPrototypes)

このメソッドは、既存のトリガープロトタイプを更新するためのものです。

パラメータ

(object/array) 更新するトリガープロトタイプのプロパティ。

各トリガープロトタイプでは triggerid プロパティを定義する必要があり、 その他のプロパティはすべて任意です。渡されたプロパティのみが 更新され、その他はすべて変更されません。

このメソッドは、標準のトリガープロトタイプの プロパティに加えて、以下の パラメータを受け付けます。

戻り値

(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.