GET /api/report_templates
Lister tous les modèles de rapport

GET /api/locations/:location_id/report_templates
Lister tous les modèles de rapport par emplacement

GET /api/organizations/:organization_id/report_templates
Lister tous les modèles de rapport par organisation

Exemples

GET /api/report_templates
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "created_at": "2019-11-07 08:49:27 UTC",
      "updated_at": "2019-11-07 08:49:27 UTC",
      "name": "report_template51",
      "id": 1007981702
    }
  ]
}

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

Champ et sens de tri, ex: ‘id DESC’

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
default true, false
location string
location_id integer
locked true, false
name string
organization string
organization_id integer
snippet true, false
template text

GET /api/report_templates/:id
Afficher un modèle de rapport

Exemples

GET /api/report_templates/1007981727-report_template71
200
{
  "template": "template content 60",
  "default": false,
  "snippet": false,
  "locked": false,
  "description": null,
  "created_at": "2019-11-07 08:49:28 UTC",
  "updated_at": "2019-11-07 08:49:28 UTC",
  "name": "report_template71",
  "id": 1007981727,
  "locations": [],
  "organizations": []
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/report_templates
Créer un modèle de rapport

Exemples

POST /api/report_templates
{
  "report_template": {
    "name": "report_template_test",
    "template": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "template": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Template can't be blank"
    ]
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

report_template
requis

Validations:

  • Must be a Hash

report_template[name]
requis

Validations:

  • Must be a String

report_template[description]
optionel , nil autorisé

Validations:

  • Must be a String

report_template[template]
requis

Validations:

  • Must be a String

report_template[snippet]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.

report_template[audit_comment]
optionel , nil autorisé

Validations:

  • Must be a String

report_template[locked]
optionel , nil autorisé

Indique si le modèle peut être modifié

Validations:

  • Must be one of: true, false, 1, 0.

report_template[default]
optionel , nil autorisé

Indique si le modèle est ajouté automatiquement aux nouvelles organisations et aux nouveaux emplacements

Validations:

  • Must be one of: true, false, 1, 0.

report_template[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

report_template[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


POST /api/report_templates/import
Importer un modèle de rapport

Exemples

POST /api/report_templates/import
{
  "report_template": {
    "name": "report_template74",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "report_template74",
  "id": 1007981731,
  "snippet": false,
  "description": null,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.417Z",
  "updated_at": "2019-11-07T08:49:28.429Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

report_template
requis

Validations:

  • Must be a Hash

report_template[name]
optionel

Nom de modèle

Validations:

  • Must be a String

report_template[template]
optionel

contenu du modèle, notamment les métadonnées

Validations:

  • Must be a String

report_template[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

report_template[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type

options
optionel

Validations:

  • Must be a Hash

options[force]
optionel , nil autorisé

à utiliser si vous voulez mettre à jour les modèles verrouillés

Validations:

  • Must be one of: true, false, 1, 0.

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:

  • Must be one of: new, always, never.

options[lock]
optionel , nil autorisé

Verrouiller les modèles importés (faux par défaut)

Validations:

  • Must be one of: true, false, 1, 0.

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:

  • Must be one of: true, false, 1, 0.


GET /api/report_templates/revision

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

version
optionel

version de modèle

Validations:

  • Must be a String


PUT /api/report_templates/:id
Mettre à jour un modèle de rapport

Exemples

PUT /api/report_templates/1007981706
{
  "report_template": {
    "template": ""
  }
}
422
{
  "error": {
    "id": 1007981706,
    "errors": {
      "template": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Template can't be blank"
    ]
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be a String

report_template
requis

Validations:

  • Must be a Hash

report_template[name]
optionel

Validations:

  • Must be a String

report_template[description]
optionel , nil autorisé

Validations:

  • Must be a String

report_template[template]
optionel

Validations:

  • Must be a String

report_template[snippet]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.

report_template[audit_comment]
optionel , nil autorisé

Validations:

  • Must be a String

report_template[locked]
optionel , nil autorisé

Indique si le modèle peut être modifié

Validations:

  • Must be one of: true, false, 1, 0.

report_template[default]
optionel , nil autorisé

Indique si le modèle est ajouté automatiquement aux nouvelles organisations et aux nouveaux emplacements

Validations:

  • Must be one of: true, false, 1, 0.

report_template[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

report_template[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


DELETE /api/report_templates/:id
Supprimer un modèle de rapport

Exemples

DELETE /api/report_templates/1007981734-report_template77
{
  "report_template": {}
}
200
{
  "id": 1007981734,
  "name": "report_template77",
  "template": "template content 65",
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.522Z",
  "updated_at": "2019-11-07T08:49:28.522Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null,
  "description": null
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be a String


POST /api/report_templates/:id/clone
Cloner un modèle

Exemples

POST /api/report_templates/1007981722-report_template67/clone
{
  "report_template": {
    "name": "MyClone"
  }
}
201
{
  "id": 1007981723,
  "name": "MyClone",
  "template": "template content 56",
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.256Z",
  "updated_at": "2019-11-07T08:49:28.256Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null,
  "description": null
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

report_template
requis

Validations:

  • Must be a Hash

report_template[name]
requis

Nom de modèle

Validations:

  • Must be a String


GET /api/report_templates/:id/export
Exporter un modèle de rapport vers ERB

Exemples

GET /api/report_templates/1007981717-report_template62/export
200
template content 51
<%#
name: report_template62
snippet: false
model: ReportTemplate
%>

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/report_templates/:id/generate
Générer un rapport à partir d'un modèle

Exemples

POST /api/report_templates/1007981727/generate
{
  "report_format": "json",
  "report_template": {}
}
200
[
  {
    "a": 1
  },
  {
    "a": 2
  }
]

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

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:

  • Must be a Hash

gzip
optionel

Compresser le rapport avec gzip

Validations:

  • Must be one of: true, false, 1, 0.

report_format
optionel

Report format, defaults to ‘csv’

Validations:

  • Must be one of: csv, json, yaml, html.


POST /api/report_templates/:id/schedule_report
Planifier la génération d'un rapport

The reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see report_data).

Exemples

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"
}
POST /api/report_templates/1007981703/schedule_report
{
  "input_values": {
    "foo": "bar"
  },
  "report_template": {}
}
200
{
  "job_id": "JOB-UNIQUE-IDENTIFIER",
  "data_url": "/api/v2/report_templates/1007981703-report_template113/report_data/JOB-UNIQUE-IDENTIFIER"
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

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:

  • Must be a Hash

gzip
optionel

Compresser le rapport avec gzip

Validations:

  • Must be one of: true, false, 1, 0.

mail_to
optionel

If set, scheduled report will be delivered via e-mail. Use ‘,’ to separate multiple email addresses.

Validations:

  • Must be a String

generate_at
optionel

UTC time to generate report at

Validations:

  • Must be a String

report_format
optionel

Report format, defaults to ‘csv’

Validations:

  • Must be one of: csv, json, yaml, html.


GET /api/report_templates/:id/report_data/:job_id
Télécharger un rapport généré

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.

Exemples

GET /api/report_templates/1007981707/report_data/JOBID
404
{
  "message": "Report not found, please ensure you used the correct job_id"
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_id
requis

ID assigned to generating job by the schedule command

Validations:

  • Must be a String