This is a translation of the original English documentation page. Help us make it better.

report.update

説明

object report.update(object/array reports)

このメソッドで、既存のスケジュールされたレポートを更新できます。

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

パラメータ

(object/array) 更新されるスケジュールされたレポートプロパティ

reportidプロパティは、スケジュールされたレポートごとに定義する必要があります。すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。

このメソッドは標準のスケジュールされたレポートプロパティに加えて、次のパラメーターを受け入れます。

パラメータ タイプ 説明
users object/array of objects スケジュールされたレポートに割り当てられている現在のユーザーを置き換えるユーザー
user_groups object/array of objects スケジュールされたレポートに割り当てられている現在のユーザーグループを置き換えるユーザーグループ

戻り値

(object) reportidsプロパティの下で更新されたスケジュールされたレポートのIDを含むオブジェクトを返します。

スケジュールされたレポートの無効化

Request:

{  "jsonrpc": "2.0",  "method": "report.update",  "params": {  "reportid": "1",  "status": "0"  },  "auth": "038e1d7b1735c6a5436ee9eae095879e",  "id": 1 }

Response:

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

参照

ソース

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