action.update

説明

object action.update(object/array actions)

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

パラメータ

(object/array) Action properties to be updated.

actionid プロパティは各アクションに対して定義する必要があり、その他のプロパティは任意です。渡されたプロパティのみが
更新され、他のプロパティは変更されません。

standard action propertiesに加えて、このメソッドは以下のパラメータを受け付けます。

戻り値

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

例

アクションを無効にする

アクションを無効にする、つまりステータスを "1" に設定します。

Request:

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

Response:

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

参照

• Action filter
• Action operation

ソース

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