このページで
report.update
説明
object report.update(object/array reports)
このメソッドでは、既存の定期レポートを更新できます。
このメソッドは、Admin および Super admin の ユーザータイプでのみ利用できます。メソッドを呼び出す権限は、ユーザーロールの 設定で取り消すことができます。詳細は、ユーザーロール を参照してください。
パラメータ
(object/array) 更新する定期レポートのプロパティ。
各定期レポートでは reportid プロパティを定義する必要があり、その他の
プロパティはすべて任意です。渡されたプロパティのみが
更新され、それ以外はすべて変更されません。
このメソッドは、標準の定期レポートの プロパティに加えて、以下のパラメータを受け付けます。
| Parameter | Type | Description |
|---|---|---|
| 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
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}関連項目
ソース
CReport::update() in ui/include/classes/api/services/CReport.php.