GET /api/organizations/114267492/report_templates 200 { "total": 1, "subtotal": 1, "page": 1, "per_page": 20, "search": "report_template6", "sort": { "by": null, "order": null }, "results": [ { "description": null, "created_at": "2024-02-22 16:16:11 UTC", "updated_at": "2024-02-22 16:16:11 UTC", "name": "report_template6", "id": 1007981711 } ] }
Param name | Description |
---|---|
location_id
optional |
Scope by locations Validations:
|
organization_id
optional |
Scope by organizations Validations:
|
search
optional |
filter results Validations:
|
order
optional |
Sort and order by a searchable field, e.g. '<field> DESC' Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return, 'all' to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
default | true, false | |
id | integer | |
location | string | |
location_id | integer | |
locked | true, false | |
name | string | |
organization | string | |
organization_id | integer | |
snippet | true, false | |
template | text |
GET /api/report_templates/1007981727-report_template18 200 { "template": "template content 17", "default": false, "snippet": false, "locked": false, "description": null, "created_at": "2024-02-22 16:16:12 UTC", "updated_at": "2024-02-22 16:16:12 UTC", "name": "report_template18", "id": 1007981727, "locations": [], "organizations": [] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
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, "description": null, "created_at": "2024-02-22 16:16:11 UTC", "updated_at": "2024-02-22 16:16:11 UTC", "name": "report_template_test", "id": 1007981713, "locations": [], "organizations": [ { "id": 114267492, "name": "Empty Organization", "title": "Empty Organization", "description": null } ] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
report_template
required |
Validations:
|
report_template[name]
required |
Validations:
|
report_template[description]
optional , nil allowed |
Validations:
|
report_template[template]
required |
Validations:
|
report_template[snippet]
optional , nil allowed |
Validations:
|
report_template[audit_comment]
optional , nil allowed |
Validations:
|
report_template[locked]
optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
report_template[default]
optional , nil allowed |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
report_template[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
POST /api/report_templates/import { "report_template": { "name": "report_template5", "template": "b" } } 201 { "template": "b", "snippet": false, "description": null, "id": 1007981710, "name": "report_template5", "template_kind_id": null, "created_at": "2024-02-22T16:16:11.900Z", "updated_at": "2024-02-22T16:16:11.905Z", "locked": false, "default": false, "vendor": null, "os_family": null, "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
report_template
required |
Validations:
|
report_template[name]
optional |
template name Validations:
|
report_template[template]
optional |
template contents including metadata Validations:
|
report_template[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
report_template[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
options
optional |
Validations:
|
options[force]
optional , nil allowed |
use if you want update locked templates Validations:
|
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:
|
options[lock]
optional , nil allowed |
lock imported templates (false by default) Validations:
|
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:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
version
optional |
template version Validations:
|
PUT /api/report_templates/1007981707 { "report_template": { "template": "new report_template template" } } 200 { "template": "new report_template template", "default": false, "snippet": false, "locked": false, "description": null, "created_at": "2024-02-22 16:16:11 UTC", "updated_at": "2024-02-22 16:16:11 UTC", "name": "report_template2", "id": 1007981707, "locations": [], "organizations": [] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
report_template
required |
Validations:
|
report_template[name]
optional |
Validations:
|
report_template[description]
optional , nil allowed |
Validations:
|
report_template[template]
optional |
Validations:
|
report_template[snippet]
optional , nil allowed |
Validations:
|
report_template[audit_comment]
optional , nil allowed |
Validations:
|
report_template[locked]
optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
report_template[default]
optional , nil allowed |
Whether or not the template is added automatically to new organizations and locations Validations:
|
report_template[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
report_template[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
DELETE /api/report_templates/1007981708-report_template3 { "report_template": {} } 200 { "id": 1007981708, "name": "report_template3", "template": "template content 3", "snippet": false, "template_kind_id": null, "created_at": "2024-02-22T16:16:11.873Z", "updated_at": "2024-02-22T16:16:11.873Z", "locked": false, "default": false, "vendor": null, "os_family": null, "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null, "description": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
POST /api/report_templates/1007981715-report_template9/clone { "report_template": { "name": "MyClone" } } 201 { "id": 1007981716, "name": "MyClone", "template": "template content 8", "snippet": false, "template_kind_id": null, "created_at": "2024-02-22T16:16:11.985Z", "updated_at": "2024-02-22T16:16:11.985Z", "locked": false, "default": false, "vendor": null, "os_family": null, "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null, "description": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
report_template
required |
Validations:
|
report_template[name]
required |
template name Validations:
|
GET /api/report_templates/1007981737-report_template26/export 200 <%# name: report_template26 snippet: false model: ReportTemplate -%> template content 25
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
input_values
optional |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip
optional |
Compress the report uzing gzip Validations:
|
report_format
optional |
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" }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
input_values
optional |
Hash of input values where key is the name of input, value is the value for this input Validations:
|
gzip
optional |
Compress the report using gzip Validations:
|
mail_to
optional |
If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. Validations:
|
generate_at
optional |
UTC time to generate report at Validations:
|
report_format
optional |
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.
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
job_id
required |
ID assigned to generating job by the schedule command Validations:
|