Nome parametro | Descrizione |
---|---|
location_id opzionale |
Scopo per posizioni Validations:
|
organization_id opzionale |
Scopo per organizzazioni Validations:
|
search opzionale |
filtra i risultati Validations:
|
order opzionale |
Sort field and order, eg. ‘id DESC’ Validations:
|
page opzionale |
Numero pagina, iniziando da 1 Validations:
|
per_page opzionale |
Numero di risultati per pagina da ritornare Validations:
|
Field name | Tipo | Possible values |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
report_template richiesto |
Validations:
|
report_template[name] richiesto |
Validations:
|
report_template[description] opzionale , consentito nil |
Validations:
|
report_template[template] richiesto |
Validations:
|
report_template[snippet] opzionale , consentito nil |
Validations:
|
report_template[audit_comment] opzionale , consentito nil |
Validations:
|
report_template[locked] opzionale , consentito nil |
Indica se il template è stato bloccato per la modifica Validations:
|
report_template[default] opzionale , consentito nil |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] opzionale , consentito nil |
SOSTITUIRE le posizioni con gli id dati Validations:
|
report_template[organization_ids] opzionale , consentito nil |
SOSTITUIRE le organizzazioni con gli id dati Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
report_template richiesto |
Validations:
|
report_template[name] opzionale |
nome template Validations:
|
report_template[template] opzionale |
template contents including metadata Validations:
|
report_template[location_ids] opzionale , consentito nil |
SOSTITUIRE le posizioni con gli id dati Validations:
|
report_template[organization_ids] opzionale , consentito nil |
SOSTITUIRE le organizzazioni con gli id dati Validations:
|
options opzionale |
Validations:
|
options[force] opzionale , consentito nil |
use if you want update locked templates Validations:
|
options[associate] opzionale , consentito nil |
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] opzionale , consentito nil |
lock imported templates (false by default) Validations:
|
options[default] opzionale , consentito nil |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
version opzionale |
versione template Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
report_template richiesto |
Validations:
|
report_template[name] opzionale |
Validations:
|
report_template[description] opzionale , consentito nil |
Validations:
|
report_template[template] opzionale |
Validations:
|
report_template[snippet] opzionale , consentito nil |
Validations:
|
report_template[audit_comment] opzionale , consentito nil |
Validations:
|
report_template[locked] opzionale , consentito nil |
Indica se il template è stato bloccato per la modifica Validations:
|
report_template[default] opzionale , consentito nil |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] opzionale , consentito nil |
SOSTITUIRE le posizioni con gli id dati Validations:
|
report_template[organization_ids] opzionale , consentito nil |
SOSTITUIRE le organizzazioni con gli id dati Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
report_template richiesto |
Validations:
|
report_template[name] richiesto |
nome template Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
input_values opzionale |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip opzionale |
Compress the report uzing gzip Validations:
|
report_format opzionale |
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" }
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
input_values opzionale |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip opzionale |
Compress the report using gzip Validations:
|
mail_to opzionale |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at opzionale |
UTC time to generate report at Validations:
|
report_format opzionale |
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.
Nome parametro | Descrizione |
---|---|
location_id opzionale |
Set the current location context for the request Validations:
|
organization_id opzionale |
Set the current organization context for the request Validations:
|
id richiesto |
Validations:
|
job_id richiesto |
ID assigned to generating job by the schedule command Validations:
|