The reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see report_data).
POST /api/report_templates/:id/schedule_report/ 200 { "job_id": UNIQUE-REPORT-GENERATING-JOB-UUID "data_url": "/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID" }
パラメーター名 | 記述 |
---|---|
location_id 任意 |
要求に現在のロケーションコンテキストを設定します Validations:
|
organization_id 任意 |
要求に現在の組織コンテキストを設定します Validations:
|
id 必須 |
Validations:
|
input_values 任意 |
入力値のハッシュ。キーは入力名で、値はこの入力の値です。 Validations:
|
gzip 任意 |
gzip でレポートの圧縮 Validations:
|
mail_to 任意 |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at 任意 |
レポート生成時間 (UTC) Validations:
|
report_format 任意 |
Report format, defaults to 'csv' Validations:
|