パラメーター名 | 記述 |
---|---|
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] 任意 , nil可 |
Validations:
|
report_template[template] 必須 |
Validations:
|
report_template[snippet] 任意 , nil可 |
Validations:
|
report_template[audit_comment] 任意 , nil可 |
Validations:
|
report_template[locked] 任意 , nil可 |
テンプレートを編集用にロックするかどうか Validations:
|
report_template[default] 任意 , nil可 |
テンプレートが自動的に新規組織およびロケーションに追加されるかどうか Validations:
|
report_template[location_ids] 任意 , nil可 |
ロケーションを指定された ID に置き換えます Validations:
|
report_template[organization_ids] 任意 , nil可 |
組織を指定された 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] 任意 , nil可 |
ロケーションを指定された ID に置き換えます Validations:
|
report_template[organization_ids] 任意 , nil可 |
組織を指定された ID に置き換えます。 Validations:
|
options 任意 |
Validations:
|
options[force] 任意 , nil可 |
ロックしたテンプレートを更新したい場合に使用 Validations:
|
options[associate] 任意 , nil可 |
テンプレートがオブジェクトをメタデータに基づいて関連付ける場合を決定します。new は新規テンプレートが作成中であることを意味します。always は、新規および更新中の既存のテンプレートを意味します。never はメタデータを無視します Validations:
|
options[lock] 任意 , nil可 |
インポートされたテンプレートをロックします (デフォルトは false) Validations:
|
options[default] 任意 , nil可 |
テンプレートにデフォルトで意味付けし、新たに作成された組織と場所に自動的に関連付けます (デフォルトは 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] 任意 , nil可 |
Validations:
|
report_template[template] 任意 |
Validations:
|
report_template[snippet] 任意 , nil可 |
Validations:
|
report_template[audit_comment] 任意 , nil可 |
Validations:
|
report_template[locked] 任意 , nil可 |
テンプレートを編集用にロックするかどうか Validations:
|
report_template[default] 任意 , nil可 |
テンプレートが自動的に新規組織およびロケーションに追加されるかどうか Validations:
|
report_template[location_ids] 任意 , nil可 |
ロケーションを指定された ID に置き換えます Validations:
|
report_template[organization_ids] 任意 , nil可 |
組織を指定された 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:
|