Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
search optional |
Ergebnisse filtern Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Ergebnisse nummerieren Validations:
|
per_page optional |
Anzahl der Einträge pro Anfrage Validations:
|
Feld Name | Typ | Mögliche Werte |
---|---|---|
default | true, false | |
location | string | |
location_id | integer | |
locked | true, false | |
name | string | |
organization | string | |
organization_id | integer | |
snippet | true, false | |
template | text |
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
report_template verpflichtend |
Validations:
|
report_template[name] verpflichtend |
Validations:
|
report_template[template] verpflichtend |
Validations:
|
report_template[snippet] optional , nil erlaubt |
Validations:
|
report_template[audit_comment] optional , nil erlaubt |
Validations:
|
report_template[locked] optional , nil erlaubt |
Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht Validations:
|
report_template[default] optional , nil erlaubt |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] optional , nil erlaubt |
Standorte durch angegebene Kennungen ERSETZEN Validations:
|
report_template[organization_ids] optional , nil erlaubt |
Organisationen durch angegebene Kennungen ERSETZEN Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
report_template verpflichtend |
Validations:
|
report_template[name] optional |
Vorlagenname Validations:
|
report_template[template] optional |
template contents including metadata Validations:
|
report_template[location_ids] optional , nil erlaubt |
Standorte durch angegebene Kennungen ERSETZEN Validations:
|
report_template[organization_ids] optional , nil erlaubt |
Organisationen durch angegebene Kennungen ERSETZEN Validations:
|
options optional |
Validations:
|
options[force] optional , nil erlaubt |
use if you want update locked templates Validations:
|
options[associate] optional , nil erlaubt |
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] optional , nil erlaubt |
Importierte Templates sperren (Standardwert: false) Validations:
|
options[default] optional , nil erlaubt |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
version optional |
Vorlagenversion Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
report_template verpflichtend |
Validations:
|
report_template[name] optional |
Validations:
|
report_template[template] optional |
Validations:
|
report_template[snippet] optional , nil erlaubt |
Validations:
|
report_template[audit_comment] optional , nil erlaubt |
Validations:
|
report_template[locked] optional , nil erlaubt |
Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht Validations:
|
report_template[default] optional , nil erlaubt |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] optional , nil erlaubt |
Standorte durch angegebene Kennungen ERSETZEN Validations:
|
report_template[organization_ids] optional , nil erlaubt |
Organisationen durch angegebene Kennungen ERSETZEN Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
report_template verpflichtend |
Validations:
|
report_template[name] verpflichtend |
Vorlagenname Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
input_values optional |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip optional |
Bericht mittels gzip komprimieren 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" }
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
input_values optional |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip optional |
Bericht mittels gzip komprimieren Validations:
|
mail_to optional |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at optional |
UTC time to generate report at 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.
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
job_id verpflichtend |
ID assigned to generation job by the schedule command Validations:
|