report.update

説明

object report.update(object/array reports)

このメソッドでは、既存の定期レポートを更新できます。

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

パラメータ

(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
}

レスポンス:

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

関連項目

ソース

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