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 選填 |
Set the current location context for the request Validations:
|
organization_id 選填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
input_values 選填 |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip 選填 |
Compress the report using gzip Validations:
|
mail_to 選填 |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at 選填 |
UTC time to generate report at Validations:
|
report_format 選填 |
Report format, defaults to 'csv' Validations:
|