Nom du paramètre | Description |
---|---|
location_id optionel |
Tri par emplacement Validations:
|
organization_id optionel |
Tri par organisation Validations:
|
search optionel |
filtrer les résultats Validations:
|
order optionel |
Champ et sens de tri, ex: 'id DESC' Validations:
|
page optionel |
Numéro de la page, commençant par 1 Validations:
|
per_page optionel |
Nombre de résultats par page à renvoyer Validations:
|
Nom du champ | Type | Valeurs possibles |
---|---|---|
default | true, false | |
location | ||
location_id | ||
locked | true, false | |
name | ||
organization | ||
organization_id | ||
snippet | true, false | |
template |
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
report_template requis |
Validations:
|
report_template[name] requis |
Validations:
|
report_template[description] optionel , nil autorisé |
Validations:
|
report_template[template] requis |
Validations:
|
report_template[snippet] optionel , nil autorisé |
Validations:
|
report_template[audit_comment] optionel , nil autorisé |
Validations:
|
report_template[locked] optionel , nil autorisé |
Indique si le modèle peut être modifié Validations:
|
report_template[default] optionel , nil autorisé |
Indique si le modèle est ajouté automatiquement aux nouvelles organisations et aux nouveaux emplacements Validations:
|
report_template[location_ids] optionel , nil autorisé |
REMPLACER les emplacements par les id donnés Validations:
|
report_template[organization_ids] optionel , nil autorisé |
REMPLACER les organisations qui ont les ID suivants Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
report_template requis |
Validations:
|
report_template[name] optionel |
Nom de modèle Validations:
|
report_template[template] optionel |
contenu du modèle, notamment les métadonnées Validations:
|
report_template[location_ids] optionel , nil autorisé |
REMPLACER les emplacements par les id donnés Validations:
|
report_template[organization_ids] optionel , nil autorisé |
REMPLACER les organisations qui ont les ID suivants Validations:
|
options optionel |
Validations:
|
options[force] optionel , nil autorisé |
à utiliser si vous voulez mettre à jour les modèles verrouillés Validations:
|
options[associate] optionel , nil autorisé |
détermine quand le modèle doit associer des objets en fonction de métadonnées, 'nouveau' signifie uniquement lors de la création d'un nouveau modèle, 'toujours' signifie à la fois pour les modèles nouveaux et existants en cours de mise à jour, 'jamais' ignore les métadonnées Validations:
|
options[lock] optionel , nil autorisé |
Verrouiller les modèles importés (faux par défaut) Validations:
|
options[default] optionel , nil autorisé |
Définit le modèle par défaut, signifiant qu'il sera automatiquement associé aux nouvelles organisations et nouveaux emplacements (faux par défaut) Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
version optionel |
version de modèle Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
report_template requis |
Validations:
|
report_template[name] optionel |
Validations:
|
report_template[description] optionel , nil autorisé |
Validations:
|
report_template[template] optionel |
Validations:
|
report_template[snippet] optionel , nil autorisé |
Validations:
|
report_template[audit_comment] optionel , nil autorisé |
Validations:
|
report_template[locked] optionel , nil autorisé |
Indique si le modèle peut être modifié Validations:
|
report_template[default] optionel , nil autorisé |
Indique si le modèle est ajouté automatiquement aux nouvelles organisations et aux nouveaux emplacements Validations:
|
report_template[location_ids] optionel , nil autorisé |
REMPLACER les emplacements par les id donnés Validations:
|
report_template[organization_ids] optionel , nil autorisé |
REMPLACER les organisations qui ont les ID suivants Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
report_template requis |
Validations:
|
report_template[name] requis |
Nom de modèle Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
input_values optionel |
Le hachage des valeurs d'entrée où key est le nom de l'entrée, value est la valeur de cette entrée Validations:
|
gzip optionel |
Compresser le rapport avec gzip Validations:
|
report_format optionel |
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" }
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
input_values optionel |
Le hachage des valeurs d'entrée où key est le nom de l'entrée, value est la valeur de cette entrée Validations:
|
gzip optionel |
Compresser le rapport avec gzip Validations:
|
mail_to optionel |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at optionel |
UTC time to generate report at Validations:
|
report_format optionel |
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.
Nom du paramètre | Description |
---|---|
location_id optionel |
Set the current location context for the request Validations:
|
organization_id optionel |
Set the current organization context for the request Validations:
|
id requis |
Validations:
|
job_id requis |
ID assigned to generating job by the schedule command Validations:
|