POST /api/report_templates
Create a report template

Examples

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": "2022-03-29 08:44:58 UTC",
  "updated_at": "2022-03-29 08:44:58 UTC",
  "name": "report_template_test",
  "id": 1007981710,
  "locations": [],
  "organizations": [
    {
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

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
report_template
required

Validations:

  • Must be a Hash
report_template[name]
required

Validations:

  • Must be a String
report_template[description]
optional , nil allowed

Validations:

  • Must be a String
report_template[template]
required

Validations:

  • Must be a String
report_template[snippet]
optional , nil allowed

Validations:

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

Validations:

  • Must be a 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