triggerprototype.update

説明

object triggerprototype.update(object/array triggerPrototypes)

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

このメソッドは 管理者 および スーパ管理者 ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

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

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

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

パラメータ	型	説明
dependencies	array	トリガープロトタイプが依存するトリガーおよびトリガープロトタイプ。トリガーには `triggerid` プロパティのみを定義する必要があります。
tags	array	トリガープロトタイプのタグ。

トリガー式は展開された形式で指定する必要があり、少なくとも1つのアイテムプロトタイプを含める必要があります。

戻り値

(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つのトリガープロトタイプのタグを置き換えます。