report.create

説明

object report.create(object/array reports)

このメソッドは新しい定期レポートを作成するためのものです。

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

パラメーター

(object/array) 作成するスケジュールレポート。

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

パラメーター 型 説明
users object/array レポートを送信するユーザー。

パラメーターの動作:
- user_groupsが設定されていない場合は必須
user_groups object/array レポートを送信するユーザーグループ。

パラメーターの動作:
- usersが設定されていない場合は必須

戻り値

(object) reportidsプロパティの下で作成されたスケジュールされたレポートのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたスケジュール済みレポートの順序と一致します。

例

スケジュールレポートの作成

2021-04-01から2021-08-31まで、毎週月曜日から金曜日の12:00に前週分の週次レポートを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "report.create",
    "params": {
        "userid": "1",
        "name": "Weekly report",
        "dashboardid": "1",
        "period": "1",
        "cycle": "1",
        "start_time": "43200",
        "weekdays": "31",
        "active_since": "2021-04-01",
        "active_till": "2021-08-31",
        "subject": "Weekly report",
        "message": "Report accompanying text",
        "status": "1",
        "description": "Report description",
        "users": [
            {
                "userid": "1",
                "access_userid": "1",
                "exclude": "0"
            },
            {
                "userid": "2",
                "access_userid": "0",
                "exclude": "1"
            }
        ],
        "user_groups": [
            {
                "usrgrpid": "7",
                "access_userid": "0"
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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