Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Zakres w zależności od lokalizacji Validations:
|
organization_id opcjonalny |
Zakres w zależności od organizacji Validations:
|
search opcjonalny |
rezultat filtrowania Validations:
|
order opcjonalny |
Sort field and order, eg. ‘id DESC’ Validations:
|
page opcjonalny |
Page number, starting at 1 Validations:
|
per_page opcjonalny |
Number of results per page to return Validations:
|
Field name | Typ | Possible values |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
report_template wymagany |
Validations:
|
report_template[name] wymagany |
Validations:
|
report_template[description] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[template] wymagany |
Validations:
|
report_template[snippet] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[audit_comment] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[locked] opcjonalny , nil dopuszczalny |
Czy szablon jest zablokowany do edycji Validations:
|
report_template[default] opcjonalny , nil dopuszczalny |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ lokalizacje o podanym id Validations:
|
report_template[organization_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ organizacje o podanym id Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
report_template wymagany |
Validations:
|
report_template[name] opcjonalny |
nazwa szablonu Validations:
|
report_template[template] opcjonalny |
template contents including metadata Validations:
|
report_template[location_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ lokalizacje o podanym id Validations:
|
report_template[organization_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ organizacje o podanym id Validations:
|
options opcjonalny |
Validations:
|
options[force] opcjonalny , nil dopuszczalny |
use if you want update locked templates Validations:
|
options[associate] opcjonalny , nil dopuszczalny |
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] opcjonalny , nil dopuszczalny |
lock imported templates (false by default) Validations:
|
options[default] opcjonalny , nil dopuszczalny |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
version opcjonalny |
wersja szablonu Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
report_template wymagany |
Validations:
|
report_template[name] opcjonalny |
Validations:
|
report_template[description] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[template] opcjonalny |
Validations:
|
report_template[snippet] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[audit_comment] opcjonalny , nil dopuszczalny |
Validations:
|
report_template[locked] opcjonalny , nil dopuszczalny |
Czy szablon jest zablokowany do edycji Validations:
|
report_template[default] opcjonalny , nil dopuszczalny |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ lokalizacje o podanym id Validations:
|
report_template[organization_ids] opcjonalny , nil dopuszczalny |
ZMIEŃ organizacje o podanym id Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
report_template wymagany |
Validations:
|
report_template[name] wymagany |
nazwa szablonu Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
input_values opcjonalny |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip opcjonalny |
Compress the report uzing gzip Validations:
|
report_format opcjonalny |
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" }
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
input_values opcjonalny |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip opcjonalny |
Compress the report using gzip Validations:
|
mail_to opcjonalny |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at opcjonalny |
UTC time to generate report at Validations:
|
report_format opcjonalny |
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.
Nazwa parametru | Opis |
---|---|
location_id opcjonalny |
Set the current location context for the request Validations:
|
organization_id opcjonalny |
Set the current organization context for the request Validations:
|
id wymagany |
Validations:
|
job_id wymagany |
ID assigned to generating job by the schedule command Validations:
|