action.update

説明

object action.update(object/array actions)

このメソッドは、既存のアクションを更新することができます。

パラメーター

(object/array) 更新するアクションのプロパティ。

actionidプロパティはアクションごとに定義する必要があり、その他のプロパティはオプションです。渡されたプロパティのみが更新され、他は一切変更されません。

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

戻り値

(object) actionidsプロパティの下で更新されたアクションIDを含むオブジェクトを返します。

例

アクションの無効化

ステータスを「1」に設定してアクションを無効にします。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "action.update",
           "params": {
               "actionid": "2",
               "status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "actionids": [
                   "2"
               ]
           },
           "id": 1
       }

参照

• Action filter
• Action operation

ソース

CAction::update() in ui/include/classes/api/services/CAction.php.