Documentation
Table of Contents
report.create
説明
object report.create(object/array reports)
このメソッドで、新しいスケジュールされたレポートを作成できます。
このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) 作成するスケジュールされたレポート
このメソッドは標準のスケジュールされたレポートプロパティに加えて、次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| users | object/array of objects | レポート送信先のユーザー |
| user_groups | object/array of objects | レポート送信先のユーザーグループ |
戻り値
(object) reportidsプロパティの下で作成されたスケジュールされたレポートのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたスケジュール済みレポートの順序と一致します。
例
スケジュールされたレポートの作成
2021-04-01から2021-08-31までの毎週月曜日から金曜日の12:00に前週に準備した週次レポートを作成します。
Request:
{
"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"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
参照
ソース
CReport::create() in ui/include/classes/api/services/CReport.php.