GET /api/report_templates
List all report templates

GET /api/locations/:location_id/report_templates
List all report templates per location

GET /api/organizations/:organization_id/report_templates
List all report templates per organization

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String

Search fields

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

GET /api/report_templates/:id
Berichtvorlage anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/report_templates
Berichtvorlage erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
verpflichtend

Validations:

  • Must be a String

report_template[template]
verpflichtend

Validations:

  • Must be a String

report_template[snippet]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.

report_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

report_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be one of: true, false, 1, 0.

report_template[default]
optional , nil erlaubt

Whether or not the template is added automatically to new organizations and locations

Validations:

  • Must be one of: true, false, 1, 0.

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


POST /api/report_templates/import
Berichtvorlage importieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
optional

Vorlagenname

Validations:

  • Must be a String

report_template[template]
optional

template contents including metadata

Validations:

  • Must be a String

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

options
optional

Validations:

  • Must be a Hash

options[force]
optional , nil erlaubt

use if you want update locked templates

Validations:

  • Must be one of: true, false, 1, 0.

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:

  • Must be one of: new, always, never.

options[lock]
optional , nil erlaubt

Importierte Templates sperren (Standardwert: false)

Validations:

  • Must be one of: true, false, 1, 0.

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:

  • Must be one of: true, false, 1, 0.


GET /api/report_templates/revision

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

version
optional

Vorlagenversion

Validations:

  • Must be a String


PUT /api/report_templates/:id
Berichtvorlage aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be a String

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
optional

Validations:

  • Must be a String

report_template[template]
optional

Validations:

  • Must be a String

report_template[snippet]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.

report_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

report_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be one of: true, false, 1, 0.

report_template[default]
optional , nil erlaubt

Whether or not the template is added automatically to new organizations and locations

Validations:

  • Must be one of: true, false, 1, 0.

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/report_templates/:id
Berichtvorlage löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be a String


POST /api/report_templates/:id/clone
Vorlage klonen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String


GET /api/report_templates/:id/export
Export a report template to ERB

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/report_templates/:id/generate
Generate report from a template

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

input_values
optional

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
optional

Bericht mittels gzip komprimieren

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/report_templates/:id/schedule_report
Schedule generating of a report

The reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see report_data).

Beispiele

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"
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

input_values
optional

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
optional

Bericht mittels gzip komprimieren

Validations:

  • Must be one of: true, false, 1, 0.

mail_to
optional

If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses.

Validations:

  • Must be a String

generate_at
optional

UTC time to generate report at

Validations:

  • Must be a String


GET /api/report_templates/:id/report_data/:job_id
Downloads a generated report

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.

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_id
verpflichtend

ID assigned to generation job by the schedule command

Validations:

  • Must be a String