POST /api/report_templates/import
Import a report template

Examples

POST /api/report_templates/import
{
  "report_template": {
    "name": "report_template10",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "report_template10",
  "id": 1007981804,
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2018-11-16T10:03:37.842Z",
  "updated_at": "2018-11-16T10:03:37.851Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": 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]
optional

template name

Validations:

  • Must be a String
report_template[template]
optional

template contents including metadata

Validations:

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

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