GET /api/report_templates
Alle Berichtvorlagen auflisten

GET /api/locations/:location_id/report_templates
Alle Bericht-Vorlagen pro Standort auflisten

GET /api/organizations/:organization_id/report_templates
Alle Bericht-Vorlagen pro Organisation auflisten

Beispiele

GET /api/report_templates
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-09-11 14:39:38 UTC",
      "updated_at": "2019-09-11 14:39:38 UTC",
      "name": "report_template36",
      "id": 1007981737
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. ‘id DESC’

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
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
Berichtvorlage anzeigen

Beispiele

GET /api/report_templates/1007981756-report_template51
200
{
  "template": "template content 46",
  "default": false,
  "snippet": false,
  "locked": false,
  "created_at": "2019-09-11 14:39:39 UTC",
  "updated_at": "2019-09-11 14:39:39 UTC",
  "name": "report_template51",
  "id": 1007981756,
  "locations": [],
  "organizations": []
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
Berichtvorlage erstellen

Beispiele

POST /api/report_templates
{
  "report_template": {
    "name": "report_template_test",
    "template": "a,b,c",
    "organization_ids": [
      114267492
    ]
  }
}
201
{
  "template": "a,b,c",
  "default": false,
  "snippet": false,
  "locked": false,
  "created_at": "2019-09-11 14:39:38 UTC",
  "updated_at": "2019-09-11 14:39:38 UTC",
  "name": "report_template_test",
  "id": 1007981732,
  "locations": [],
  "organizations": [
    {
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
verpflichtend

Validations:

  • Must be a String

report_template[template]
verpflichtend

Validations:

  • Must be a String

report_template[snippet]
optional , nil erlaubt

Validations:

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

report_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

report_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

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

report_template[default]
optional , nil erlaubt

Ob eine Vorlage automatisch zu einer Organisation oder einen Standort hinzugefügt wird oder nicht

Validations:

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

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


POST /api/report_templates/import
Berichtvorlage importieren

Beispiele

POST /api/report_templates/import
{
  "report_template": {
    "name": "report_template39",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "report_template39",
  "id": 1007981740,
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-09-11T14:39:38.542Z",
  "updated_at": "2019-09-11T14:39:38.555Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
optional

Vorlagenname

Validations:

  • Must be a String

report_template[template]
optional

Vorlagen-Inhalte die Meta-Daten enthalten

Validations:

  • Must be a String

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

options
optional

Validations:

  • Must be a Hash

options[force]
optional , nil erlaubt

Nutzen, wenn sie gesperrte Vorlagen aktualisieren wollen

Validations:

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

options[associate]
optional , nil erlaubt

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:

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

options[lock]
optional , nil erlaubt

Importierte Templates sperren (Standardwert: false)

Validations:

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

options[default]
optional , nil erlaubt

macht eine Vorlage zur Standardvorlage. Standardvorlagen werden automatisch zu neuen Organisationen und Standorten hinzugefügt. (Standardmäßig falsch)

Validations:

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


GET /api/report_templates/revision

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

version
optional

Vorlagenversion

Validations:

  • Must be a String


PUT /api/report_templates/:id
Berichtvorlage aktualisieren

Beispiele

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

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be a String

report_template
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
optional

Validations:

  • Must be a String

report_template[template]
optional

Validations:

  • Must be a String

report_template[snippet]
optional , nil erlaubt

Validations:

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

report_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

report_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

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

report_template[default]
optional , nil erlaubt

Ob eine Vorlage automatisch zu einer Organisation oder einen Standort hinzugefügt wird oder nicht

Validations:

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

report_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

report_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/report_templates/:id
Berichtvorlage löschen

Beispiele

DELETE /api/report_templates/1007981749-report_template46
{
  "report_template": {}
}
200
{
  "id": 1007981749,
  "name": "report_template46",
  "template": "template content 41",
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-09-11T14:39:38.775Z",
  "updated_at": "2019-09-11T14:39:38.775Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be a String


POST /api/report_templates/:id/clone
Vorlage klonen

Beispiele

POST /api/report_templates/1007981743-report_template42/clone
{
  "report_template": {
    "name": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

report_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String


GET /api/report_templates/:id/export
Export einer Bericht-Vorlage nach ERB

Beispiele

GET /api/report_templates/1007981763-report_template58/export
200
template content 53
<%#
name: report_template58
snippet: false
model: ReportTemplate
%>

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
Generiere Bericht von Vorlage

Beispiele

POST /api/report_templates/1007981703/generate
{
  "input_values": {
    "hello": "ohai"
  },
  "report_template": {}
}
200
2 ohai

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
optional

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
optional

Bericht mittels gzip komprimieren

Validations:

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


POST /api/report_templates/:id/schedule_report
Plane die Generierung eines Berichts

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

Beispiele

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
{
  "report_template": {}
}
200
{
  "job_id": "JOB-UNIQUE-IDENTIFIER",
  "data_url": "/api/v2/report_templates/1007981703-report_template25/report_data/JOB-UNIQUE-IDENTIFIER"
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
optional

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
optional

Bericht mittels gzip komprimieren

Validations:

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

mail_to
optional

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

Validations:

  • Must be a String

generate_at
optional

UTC-Zeit zu der ein Bericht generiert wird

Validations:

  • Must be a String


GET /api/report_templates/:id/report_data/:job_id
Läd einen generierten Bericht herunter

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.

Beispiele

GET /api/report_templates/1007981712/report_data/JOBID
204

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

ID assigned to generating job by the schedule command

Validations:

  • Must be a String