参数名字 | 描述 |
---|---|
location_id 选填 |
根据位置界定的范围 Validations:
|
organization_id 选填 |
根据机构界定的范围 Validations:
|
search 选填 |
过滤结果 Validations:
|
order 选填 |
排序项和顺序,例如 ‘id DESC’ Validations:
|
page 选填 |
页号,从 1 开始 Validations:
|
per_page 选填 |
每页中显示的返回结果数 Validations:
|
字段名 | 类型 | 可能的值 |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
report_template 必填 |
Validations:
|
report_template[name] 必填 |
Validations:
|
report_template[description] 选填 , 允许空值 |
Validations:
|
report_template[template] 必填 |
Validations:
|
report_template[snippet] 选填 , 允许空值 |
Validations:
|
report_template[audit_comment] 选填 , 允许空值 |
Validations:
|
report_template[locked] 选填 , 允许空值 |
是否已锁定该模板进行编辑 Validations:
|
report_template[default] 选填 , 允许空值 |
模板是否会自动添加到新的机构和位置 Validations:
|
report_template[location_ids] 选填 , 允许空值 |
使用给定 id 替换位置 Validations:
|
report_template[organization_ids] 选填 , 允许空值 |
使用给定 id 替换机构 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
report_template 必填 |
Validations:
|
report_template[name] 选填 |
模板名称 Validations:
|
report_template[template] 选填 |
包括元数据的模板内容 Validations:
|
report_template[location_ids] 选填 , 允许空值 |
使用给定 id 替换位置 Validations:
|
report_template[organization_ids] 选填 , 允许空值 |
使用给定 id 替换机构 Validations:
|
options 选填 |
Validations:
|
options[force] 选填 , 允许空值 |
在您希望更新锁定的模板时使用 Validations:
|
options[associate] 选填 , 允许空值 |
确定模板何时应基于元数据关联对象,new 表示只在创建新模板时,always 表示同时适用于新模板和的只进行更新的现有模板,never 表示忽略元数据 Validations:
|
options[lock] 选填 , 允许空值 |
锁定导入的模板(默认为 false) Validations:
|
options[default] 选填 , 允许空值 |
把模块设为默认意味着它将自动与新创建的组织和位置相关联(默认为 false) Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
version 选填 |
模板版本 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
report_template 必填 |
Validations:
|
report_template[name] 选填 |
Validations:
|
report_template[description] 选填 , 允许空值 |
Validations:
|
report_template[template] 选填 |
Validations:
|
report_template[snippet] 选填 , 允许空值 |
Validations:
|
report_template[audit_comment] 选填 , 允许空值 |
Validations:
|
report_template[locked] 选填 , 允许空值 |
是否已锁定该模板进行编辑 Validations:
|
report_template[default] 选填 , 允许空值 |
模板是否会自动添加到新的机构和位置 Validations:
|
report_template[location_ids] 选填 , 允许空值 |
使用给定 id 替换位置 Validations:
|
report_template[organization_ids] 选填 , 允许空值 |
使用给定 id 替换机构 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
report_template 必填 |
Validations:
|
report_template[name] 必填 |
模板名称 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
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 选填 |
哈希输入值,其中关键字是输入名称,值是这个输入 Validations:
|
gzip 选填 |
Compress the report uzing gzip Validations:
|
report_format 选填 |
Report format, defaults to 'csv' Validations:
|
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 选填 |
哈希输入值,其中关键字是输入名称,值是这个输入 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:
|
Returns the report data as a raw response. In case the report hasn't been generated yet, it will return an empty response with http status 204 - NoContent.
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
job_id 必填 |
ID assigned to generating job by the schedule command Validations:
|