Table of Contents
report.update
説明
object report.update(object/array reports)
このメソッドは、既存のスケジュールレポートを更新するためのものです。
このメソッドは管理者およびスーパ管理者ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object/array) 更新するスケジュールレポートのプロパティ。
各スケジュールレポートには reportid プロパティを定義する必要があり、他のプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。
標準のスケジュールレポートプロパティに加えて、このメソッドは以下のパラメータを受け付けます。
| パラメータ | 型 | 説明 |
|---|---|---|
| users | object/array | スケジュールレポートに割り当てられている現在のユーザーを置き換えるユーザー。 パラメータの動作: - user_groupsが設定されていない場合は必須 |
| user_groups | object/array | スケジュールレポートに割り当てられている現在のユーザーグループを置き換えるユーザーグループ。 パラメータの動作: - usersが設定されていない場合は必須 |
戻り値
(object) reportidsプロパティの下で更新されたスケジュールされたレポートのIDを含むオブジェクトを返します。
例
スケジュールレポートの無効化
{
"jsonrpc": "2.0",
"method": "report.update",
"params": {
"reportid": "1",
"status": "0"
},
"id": 1
}レスポンス:
参照
ソース
CReport::update() in ui/include/classes/api/services/CReport.php.