參數名字 | 描述 |
---|---|
location_id 選填 |
位置範圍 Validations:
|
organization_id 選填 |
組織範圍 Validations:
|
search 選填 |
篩選結果 Validations:
|
order 選填 |
Sort field and order, eg. ‘id DESC’ Validations:
|
page 選填 |
頁數,從 1 開始 Validations:
|
per_page 選填 |
每頁要傳回的結果數量 Validations:
|
Field name | 類型 | Possible values |
---|---|---|
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] 選填 , 允許空值 |
Whether or not the template is added automatically to new organizations and locations 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] 選填 |
template contents including metadata Validations:
|
report_template[location_ids] 選填 , 允許空值 |
將位置取代為特定 ID Validations:
|
report_template[organization_ids] 選填 , 允許空值 |
將組織取代為特定 ID。 Validations:
|
options 選填 |
Validations:
|
options[force] 選填 , 允許空值 |
use if you want update locked templates Validations:
|
options[associate] 選填 , 允許空值 |
determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Validations:
|
options[lock] 選填 , 允許空值 |
lock imported templates (false by default) Validations:
|
options[default] 選填 , 允許空值 |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) 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] 選填 , 允許空值 |
Whether or not the template is added automatically to new organizations and locations 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 選填 |
Hash of input values where key is the name of input, value is the value for this input 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 選填 |
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:
|
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:
|