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

Примеры

GET /api/report_templates
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "created_at": "2019-11-07 08:49:27 UTC",
      "updated_at": "2019-11-07 08:49:27 UTC",
      "name": "report_template51",
      "id": 1007981702
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип 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

Примеры

GET /api/report_templates/1007981727-report_template71
200
{
  "template": "template content 60",
  "default": false,
  "snippet": false,
  "locked": false,
  "description": null,
  "created_at": "2019-11-07 08:49:28 UTC",
  "updated_at": "2019-11-07 08:49:28 UTC",
  "name": "report_template71",
  "id": 1007981727,
  "locations": [],
  "organizations": []
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/report_templates
Create a report template

Примеры

POST /api/report_templates
{
  "report_template": {
    "name": "report_template_test",
    "template": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "template": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Template can't be blank"
    ]
  }
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

report_template
обязательно

Validations:

  • Must be a Hash

report_template[name]
обязательно

Validations:

  • Must be a String

report_template[description]
необязательно , nil разрешен

Validations:

  • Must be a String

report_template[template]
обязательно

Validations:

  • Must be a String

report_template[snippet]
необязательно , nil разрешен

Validations:

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

report_template[audit_comment]
необязательно , nil разрешен

Validations:

  • Must be a String

report_template[locked]
необязательно , nil разрешен

Блокирование шаблона для редактирования

Validations:

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

report_template[default]
необязательно , nil разрешен

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]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

report_template[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


POST /api/report_templates/import
Import a report template

Примеры

POST /api/report_templates/import
{
  "report_template": {
    "name": "report_template74",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "report_template74",
  "id": 1007981731,
  "snippet": false,
  "description": null,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.417Z",
  "updated_at": "2019-11-07T08:49:28.429Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

report_template
обязательно

Validations:

  • Must be a Hash

report_template[name]
необязательно

имя шаблона

Validations:

  • Must be a String

report_template[template]
необязательно

template contents including metadata

Validations:

  • Must be a String

report_template[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

report_template[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type

options
необязательно

Validations:

  • Must be a Hash

options[force]
необязательно , nil разрешен

use if you want update locked templates

Validations:

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

options[associate]
необязательно , nil разрешен

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]
необязательно , nil разрешен

lock imported templates (false by default)

Validations:

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

options[default]
необязательно , nil разрешен

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

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

version
необязательно

версия шаблона

Validations:

  • Must be a String


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

Примеры

PUT /api/report_templates/1007981706
{
  "report_template": {
    "template": ""
  }
}
422
{
  "error": {
    "id": 1007981706,
    "errors": {
      "template": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Template can't be blank"
    ]
  }
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be a String

report_template
обязательно

Validations:

  • Must be a Hash

report_template[name]
необязательно

Validations:

  • Must be a String

report_template[description]
необязательно , nil разрешен

Validations:

  • Must be a String

report_template[template]
необязательно

Validations:

  • Must be a String

report_template[snippet]
необязательно , nil разрешен

Validations:

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

report_template[audit_comment]
необязательно , nil разрешен

Validations:

  • Must be a String

report_template[locked]
необязательно , nil разрешен

Блокирование шаблона для редактирования

Validations:

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

report_template[default]
необязательно , nil разрешен

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]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

report_template[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


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

Примеры

DELETE /api/report_templates/1007981734-report_template77
{
  "report_template": {}
}
200
{
  "id": 1007981734,
  "name": "report_template77",
  "template": "template content 65",
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.522Z",
  "updated_at": "2019-11-07T08:49:28.522Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null,
  "description": null
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be a String


POST /api/report_templates/:id/clone
Клонировать шаблон

Примеры

POST /api/report_templates/1007981722-report_template67/clone
{
  "report_template": {
    "name": "MyClone"
  }
}
201
{
  "id": 1007981723,
  "name": "MyClone",
  "template": "template content 56",
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-11-07T08:49:28.256Z",
  "updated_at": "2019-11-07T08:49:28.256Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": null,
  "description": null
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

report_template
обязательно

Validations:

  • Must be a Hash

report_template[name]
обязательно

имя шаблона

Validations:

  • Must be a String


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

Примеры

GET /api/report_templates/1007981717-report_template62/export
200
template content 51
<%#
name: report_template62
snippet: false
model: ReportTemplate
%>

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


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

Примеры

POST /api/report_templates/1007981727/generate
{
  "report_format": "json",
  "report_template": {}
}
200
[
  {
    "a": 1
  },
  {
    "a": 2
  }
]

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
необязательно

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
необязательно

Compress the report uzing gzip

Validations:

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

report_format
необязательно

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).

Примеры

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"
}
POST /api/report_templates/1007981703/schedule_report
{
  "input_values": {
    "foo": "bar"
  },
  "report_template": {}
}
200
{
  "job_id": "JOB-UNIQUE-IDENTIFIER",
  "data_url": "/api/v2/report_templates/1007981703-report_template113/report_data/JOB-UNIQUE-IDENTIFIER"
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
необязательно

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
необязательно

Compress the report using gzip

Validations:

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

mail_to
необязательно

If set, scheduled report will be delivered via e-mail. Use ‘,’ to separate multiple email addresses.

Validations:

  • Must be a String

generate_at
необязательно

UTC time to generate report at

Validations:

  • Must be a String

report_format
необязательно

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.

Примеры

GET /api/report_templates/1007981707/report_data/JOBID
404
{
  "message": "Report not found, please ensure you used the correct job_id"
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_id
обязательно

ID assigned to generating job by the schedule command

Validations:

  • Must be a String