action.update

説明

object action.update(object/array actions)

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

このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

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

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

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

パラメーター タイプ 説明
filter object 現在のフィルターを置き換えるアクションフィルターオブジェクト。
operations array 既存の操作を置き換えるアクション操作。
recovery_operations array 既存の回復操作を置き換えるアクション回復操作。

パラメーターの動作:
- Actionオブジェクトのeventsourceが"event created by a trigger"、"internal event"または"event created on service status update"に設定されている場合、サポート
update_operations array 既存の更新操作を置き換えるアクション更新操作。

パラメーターの動作:
- Actionオブジェクトのeventsourceが"event created by a trigger"または"event created on service status update"に設定されている場合、サポート

戻り値

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

例

アクションの無効化

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

リクエスト:

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

レスポンス:

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

参照

ソース

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