Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
search opcional |
filtrar resultados Validations:
|
order opcional |
Classificar campo e ordem, ex.: ‘id DESC’ Validations:
|
page opcional |
Número de página, iniciando em 1 Validations:
|
per_page opcional |
Número de resultados por página para retornar Validations:
|
Nome do campo | Tipo | Valores possíveis |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
report_template requerido |
Validations:
|
report_template[name] requerido |
Validations:
|
report_template[description] opcional , nulo permitido |
Validations:
|
report_template[template] requerido |
Validations:
|
report_template[snippet] opcional , nulo permitido |
Validations:
|
report_template[audit_comment] opcional , nulo permitido |
Validations:
|
report_template[locked] opcional , nulo permitido |
Se deve ou não o template está bloqueado para edição Validations:
|
report_template[default] opcional , nulo permitido |
Define se o modelo é ou não adicionado automaticamente a novas organizações e locais Validations:
|
report_template[location_ids] opcional , nulo permitido |
SUBSTITUIR localizações dadas com ids Validations:
|
report_template[organization_ids] opcional , nulo permitido |
SUBSTITUIR organizações dadas com ids Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
report_template requerido |
Validations:
|
report_template[name] opcional |
nome do modelo Validations:
|
report_template[template] opcional |
conteúdos do modelo incluindo metadados Validations:
|
report_template[location_ids] opcional , nulo permitido |
SUBSTITUIR localizações dadas com ids Validations:
|
report_template[organization_ids] opcional , nulo permitido |
SUBSTITUIR organizações dadas com ids Validations:
|
options opcional |
Validations:
|
options[force] opcional , nulo permitido |
use se você deseja atualizar modelos bloquados Validations:
|
options[associate] opcional , nulo permitido |
determina quando o modelo deve associar objetos com base nos metadados. Novo significa somente quando um novo modelo está sendo criado; Sempre é para modelos novos e existentes que somente estão sendo atualizados; nunca ignora os metadados. Validations:
|
options[lock] opcional , nulo permitido |
bloquear modelos importados (falso por padrão) Validations:
|
options[default] opcional , nulo permitido |
faz o padrão do modelo, o que significa que ele será automaticamente associado a organizações e locais criados recentemente (falso por padrão) Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
version opcional |
versão do modelo Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
report_template requerido |
Validations:
|
report_template[name] opcional |
Validations:
|
report_template[description] opcional , nulo permitido |
Validations:
|
report_template[template] opcional |
Validations:
|
report_template[snippet] opcional , nulo permitido |
Validations:
|
report_template[audit_comment] opcional , nulo permitido |
Validations:
|
report_template[locked] opcional , nulo permitido |
Se deve ou não o template está bloqueado para edição Validations:
|
report_template[default] opcional , nulo permitido |
Define se o modelo é ou não adicionado automaticamente a novas organizações e locais Validations:
|
report_template[location_ids] opcional , nulo permitido |
SUBSTITUIR localizações dadas com ids Validations:
|
report_template[organization_ids] opcional , nulo permitido |
SUBSTITUIR organizações dadas com ids Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
report_template requerido |
Validations:
|
report_template[name] requerido |
nome do modelo Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
input_values opcional |
Hash de valores de entrada em que a chave é o nome da entrada, o valor é o valor para essa entrada Validations:
|
gzip opcional |
Compress the report uzing gzip Validations:
|
report_format opcional |
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 parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
input_values opcional |
Hash de valores de entrada em que a chave é o nome da entrada, o valor é o valor para essa entrada Validations:
|
gzip opcional |
Compress the report using gzip Validations:
|
mail_to opcional |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at opcional |
UTC time to generate report at Validations:
|
report_format opcional |
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 parâmetro | Descrição |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
job_id requerido |
ID assigned to generating job by the schedule command Validations:
|