Report templates

>>>

GET /api/report_templates
List all report templates

GET /api/locations/:location_id/report_templates
List all report templates per location

GET /api/organizations/:organization_id/report_templates
List all report templates per organization

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
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
Show a report template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/report_templates
Create a report template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
report_template
required

Validations:

  • Hash
report_template[name]
required

Validations:

  • String
report_template[description]
optional , nil allowed

Validations:

  • String
report_template[template]
required

Validations:

  • String
report_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
report_template[audit_comment]
optional , nil allowed

Validations:

  • String
report_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.
report_template[default]
optional , nil allowed

Whether or not the template is added automatically to new organizations and locations

Validations:

  • Must be one of: true, false, 1, 0.
report_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
report_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

POST /api/report_templates/import
Import a report template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
report_template
required

Validations:

  • Hash
report_template[name]
optional

template name

Validations:

  • String
report_template[template]
optional

template contents including metadata

Validations:

  • String
report_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
report_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
options
optional

Validations:

  • Hash
options[force]
optional , nil allowed

use if you want update locked templates

Validations:

  • Must be one of: true, false, 1, 0.
options[associate]
optional , nil allowed

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 allowed

lock imported templates (false by default)

Validations:

  • Must be one of: true, false, 1, 0.
options[default]
optional , nil allowed

makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

Validations:

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

GET /api/report_templates/revision

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
version
optional

template version

Validations:

  • String
>>>

PUT /api/report_templates/:id
Update a report template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
report_template
required

Validations:

  • Hash
report_template[name]
optional

Validations:

  • String
report_template[description]
optional , nil allowed

Validations:

  • String
report_template[template]
optional

Validations:

  • String
report_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
report_template[audit_comment]
optional , nil allowed

Validations:

  • String
report_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.
report_template[default]
optional , nil allowed

Whether or not the template is added automatically to new organizations and locations

Validations:

  • Must be one of: true, false, 1, 0.
report_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
report_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

DELETE /api/report_templates/:id
Delete a report template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
>>>

POST /api/report_templates/:id/clone
Clone a template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
report_template
required

Validations:

  • Hash
report_template[name]
required

template name

Validations:

  • String
>>>

GET /api/report_templates/:id/export
Export a report template to ERB

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/report_templates/:id/generate
Generate report from a template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' 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:

  • Hash
gzip
optional

Compress the report uzing gzip

Validations:

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

Report format, defaults to 'csv'

Validations:

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

POST /api/report_templates/:id/schedule_report
Schedule generating of a report

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

Examples

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"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' 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:

  • Hash
gzip
optional

Compress the report using gzip

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:

  • String
generate_at
optional

UTC time to generate report at

Validations:

  • String
report_format
optional

Report format, defaults to 'csv'

Validations:

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

GET /api/report_templates/:id/report_data/:job_id
Downloads a generated report

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.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
job_id
required

ID assigned to generating job by the schedule command

Validations:

  • String