Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Alcance por ubicación Validations:
|
organization_id opcional |
Alcance por organización Validations:
|
search opcional |
filtrar resultados Validations:
|
order opcional |
Orden y campo de clasificación, p. ej., 'id DESC' Validations:
|
page opcional |
Número de página, comenzando por 1 Validations:
|
per_page opcional |
Número de resultados por página para devolver Validations:
|
Nombre del campo | Tipo | Valores posibles |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Nombre del parámetro | Descripción |
---|---|
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:
|
Nombre del parámetro | Descripción |
---|---|
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 , nil permitido |
Validations:
|
report_template[template] requerido |
Validations:
|
report_template[snippet] opcional , nil permitido |
Validations:
|
report_template[audit_comment] opcional , nil permitido |
Validations:
|
report_template[locked] opcional , nil permitido |
Si la plantilla está bloqueada o no para edición Validations:
|
report_template[default] opcional , nil permitido |
Si la plantilla se agrega automáticamente a nuevas ubicaciones y organizaciones Validations:
|
report_template[location_ids] opcional , nil permitido |
REMPLAZAR ubicaciones con ID dadas Validations:
|
report_template[organization_ids] opcional , nil permitido |
REMPLAZAR organizaciones con ID dadas. Validations:
|
Nombre del parámetro | Descripción |
---|---|
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 |
nombre de plantilla Validations:
|
report_template[template] opcional |
contenidos de plantillas incluidos los metadatos Validations:
|
report_template[location_ids] opcional , nil permitido |
REMPLAZAR ubicaciones con ID dadas Validations:
|
report_template[organization_ids] opcional , nil permitido |
REMPLAZAR organizaciones con ID dadas. Validations:
|
options opcional |
Validations:
|
options[force] opcional , nil permitido |
utilizar si desea actualizar las plantillas bloqueadas Validations:
|
options[associate] opcional , nil permitido |
determina los casos en que la plantilla debería asociar objetos en función de los metadatos, nuevo se aplica solo a los casos de plantilla nueva que se está creando, siempre se aplica tanto a plantilla nueva como existente que solo se están actualizando, nunca ignora los metadatos Validations:
|
options[lock] opcional , nil permitido |
bloquear plantillas importadas (falso de manera predeterminada) Validations:
|
options[default] opcional , nil permitido |
configura la plantilla como predeterminada, lo que significa que se asociará automáticamente con las ubicaciones y organizaciones nuevas creadas (falso de manera predeterminada) Validations:
|
Nombre del parámetro | Descripción |
---|---|
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 |
versión de plantilla Validations:
|
Nombre del parámetro | Descripción |
---|---|
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 , nil permitido |
Validations:
|
report_template[template] opcional |
Validations:
|
report_template[snippet] opcional , nil permitido |
Validations:
|
report_template[audit_comment] opcional , nil permitido |
Validations:
|
report_template[locked] opcional , nil permitido |
Si la plantilla está bloqueada o no para edición Validations:
|
report_template[default] opcional , nil permitido |
Si la plantilla se agrega automáticamente a nuevas ubicaciones y organizaciones Validations:
|
report_template[location_ids] opcional , nil permitido |
REMPLAZAR ubicaciones con ID dadas Validations:
|
report_template[organization_ids] opcional , nil permitido |
REMPLAZAR organizaciones con ID dadas. Validations:
|
Nombre del parámetro | Descripción |
---|---|
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:
|
Nombre del parámetro | Descripción |
---|---|
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 |
nombre de plantilla Validations:
|
Nombre del parámetro | Descripción |
---|---|
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:
|
Nombre del parámetro | Descripción |
---|---|
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 donde la clave es el nombre de la entrada; el valor es el valor para esta 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" }
Nombre del parámetro | Descripción |
---|---|
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 donde la clave es el nombre de la entrada; el valor es el valor para esta 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.
Nombre del parámetro | Descripción |
---|---|
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:
|