Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
search необязательно |
отфильтровать результаты Validations:
|
order необязательно |
Sort field and order, eg. ‘id DESC’ Validations:
|
page необязательно |
Номер страницы, начиная с 1 Validations:
|
per_page необязательно |
Число элементов на странице Validations:
|
Field name | Тип | Possible values |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
report_template обязательно |
Validations:
|
report_template[name] обязательно |
Validations:
|
report_template[description] необязательно , nil разрешен |
Validations:
|
report_template[template] обязательно |
Validations:
|
report_template[snippet] необязательно , nil разрешен |
Validations:
|
report_template[audit_comment] необязательно , nil разрешен |
Validations:
|
report_template[locked] необязательно , nil разрешен |
Блокирование шаблона для редактирования Validations:
|
report_template[default] необязательно , nil разрешен |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ местоположения с заданным кодом Validations:
|
report_template[organization_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ организации с заданным кодом Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
report_template обязательно |
Validations:
|
report_template[name] необязательно |
имя шаблона Validations:
|
report_template[template] необязательно |
template contents including metadata Validations:
|
report_template[location_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ местоположения с заданным кодом Validations:
|
report_template[organization_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ организации с заданным кодом Validations:
|
options необязательно |
Validations:
|
options[force] необязательно , nil разрешен |
use if you want update locked templates Validations:
|
options[associate] необязательно , 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] необязательно , nil разрешен |
lock imported templates (false by default) Validations:
|
options[default] необязательно , nil разрешен |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
version необязательно |
версия шаблона Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
report_template обязательно |
Validations:
|
report_template[name] необязательно |
Validations:
|
report_template[description] необязательно , nil разрешен |
Validations:
|
report_template[template] необязательно |
Validations:
|
report_template[snippet] необязательно , nil разрешен |
Validations:
|
report_template[audit_comment] необязательно , nil разрешен |
Validations:
|
report_template[locked] необязательно , nil разрешен |
Блокирование шаблона для редактирования Validations:
|
report_template[default] необязательно , nil разрешен |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ местоположения с заданным кодом Validations:
|
report_template[organization_ids] необязательно , nil разрешен |
ЗАМЕСТИТЬ организации с заданным кодом Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
report_template обязательно |
Validations:
|
report_template[name] обязательно |
имя шаблона Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
input_values необязательно |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip необязательно |
Compress the report uzing gzip Validations:
|
report_format необязательно |
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" }
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
input_values необязательно |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip необязательно |
Compress the report using gzip Validations:
|
mail_to необязательно |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at необязательно |
UTC time to generate report at Validations:
|
report_format необязательно |
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.
Имя параметра | Описание |
---|---|
location_id необязательно |
Set the current location context for the request Validations:
|
organization_id необязательно |
Set the current organization context for the request Validations:
|
id обязательно |
Validations:
|
job_id обязательно |
ID assigned to generating job by the schedule command Validations:
|