Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
search optional |
filtra els resultats Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Nombre de resultats per pàgina a retornar Validations:
|
Field name | Tipus | Possible values |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
report_template required |
Validations:
|
report_template[name] required |
Validations:
|
report_template[description] optional , nil allowed |
Validations:
|
report_template[template] required |
Validations:
|
report_template[snippet] optional , nil allowed |
Validations:
|
report_template[audit_comment] optional , nil allowed |
Validations:
|
report_template[locked] optional , nil allowed |
Determina si una plantilla està bloquejada o no per a l'edició Validations:
|
report_template[default] optional , nil allowed |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] optional , nil allowed |
SUBSTITUEIX les ubicacions amb els ID donats Validations:
|
report_template[organization_ids] optional , nil allowed |
SUBSTITUEIX les organitzacions amb els ID donats. Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
report_template required |
Validations:
|
report_template[name] optional |
nom de la plantilla Validations:
|
report_template[template] optional |
template contents including metadata Validations:
|
report_template[location_ids] optional , nil allowed |
SUBSTITUEIX les ubicacions amb els ID donats Validations:
|
report_template[organization_ids] optional , nil allowed |
SUBSTITUEIX les organitzacions amb els ID donats. Validations:
|
options optional |
Validations:
|
options[force] optional , nil allowed |
use if you want update locked templates Validations:
|
options[associate] optional , nil allowed |
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 allowed |
lock imported templates (false by default) Validations:
|
options[default] optional , nil allowed |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
version optional |
versió de la plantilla Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
report_template required |
Validations:
|
report_template[name] optional |
Validations:
|
report_template[description] optional , nil allowed |
Validations:
|
report_template[template] optional |
Validations:
|
report_template[snippet] optional , nil allowed |
Validations:
|
report_template[audit_comment] optional , nil allowed |
Validations:
|
report_template[locked] optional , nil allowed |
Determina si una plantilla està bloquejada o no per a l'edició Validations:
|
report_template[default] optional , nil allowed |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] optional , nil allowed |
SUBSTITUEIX les ubicacions amb els ID donats Validations:
|
report_template[organization_ids] optional , nil allowed |
SUBSTITUEIX les organitzacions amb els ID donats. Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
report_template required |
Validations:
|
report_template[name] required |
nom de la plantilla Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
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 |
Compress the report uzing gzip Validations:
|
report_format optional |
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" }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
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 |
Compress the report using gzip 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:
|
report_format optional |
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.
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
job_id required |
ID assigned to generating job by the schedule command Validations:
|