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

Examples

POST /api/report_templates/1007981707/generate
{
  "report_format": "txt",
  "report_template": {}
}
200
a
1
2

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

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

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.