action.update
説明
object action.update(object/array actions)
このメソッドは、既存のアクションを更新することができます。
このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object/array) 更新するアクションのプロパティ。
各アクションでは actionid プロパティを定義する必要があり、その他の
プロパティはすべて任意です。渡されたプロパティのみが更新され、その他
は変更されません。
このメソッドは、標準のアクションプロパティ に加えて、 以下のパラメータを受け付けます。
| パラメータ | 型 | 説明 |
|---|---|---|
| filter | object | 現在のフィルターを置き換える アクションフィルター オブジェクト。 |
| operations | array | 既存の実行内容を置き換える アクションの実行内容。 |
| recovery_operations | array | 既存のリカバリー実行内容を置き換える アクションのリカバリー実行内容。 パラメータの動作: - アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合に supported |
| update_operations | array | 既存の更新実行内容を置き換える アクションの更新実行内容。 パラメータの動作: - アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」または「サービスステータス更新時に作成されたイベント」に設定されている場合に supported |
戻り値
(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.