Templates

Manage report templates, visual templates, and input configuration templates.

Overview

Templates provide reusable configurations for reports:

• Report Templates - Complete report layouts and structure
• Visual Templates - Chart and visualization configurations
• Input Templates - User input parameter definitions
• Input Filter Templates - Filter UI configurations

GET /api/report-templates

Get all available report templates.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/report-templates" }
  },
  "_embedded": {
    "inf:template": [
      {
        "id": "template-1",
        "name": "Sales Dashboard Template",
        "description": "Pre-built sales analysis dashboard"
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

---

GET /api/reports/template

Get the default report template.

Authentication: Required

Response:

Returns the default template object.

---

GET /api/reports/{id}/templates

Get all templates associated with a specific report.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Report ID

Response:

{
  "_links": {
    "self": { "href": "/api/reports/{id}/templates" }
  },
  "_embedded": {
    "inf:template": [
      {
        "id": "uuid",
        "reportId": "team:sales-dashboard",
        "templateId": "template-1",
        "template": {
          "id": "template-1",
          "name": "Sales Dashboard Template"
        }
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

---

POST /api/reports/{id}/templates

Associate a template with a report.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Report ID

Request Body:

{
  "templateId": "template-1"
}

Response:

{
  "id": "uuid",
  "reportId": "team:sales-dashboard",
  "templateId": "template-1"
}

Status Code: 201 Created

---

GET /api/reports/{id}/visual-templates

Get available visual templates for a report.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Report ID

Response:

Returns an array of visual template definitions (charts, tables, etc.) compatible with the report.

[
  {
    "id": "bar-chart",
    "name": "Bar Chart",
    "type": "chart",
    "component": {}
  },
  {
    "id": "line-chart",
    "name": "Line Chart",
    "type": "chart",
    "component": {}
  }
]

Use Case:

Get available visualization types when building or editing a report.

---

GET /api/reports/{id}/input-templates

Get available input parameter templates for a report.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Report ID

Response:

Returns an array of input parameter template definitions.

[
  {
    "id": "date-range",
    "name": "Date Range",
    "type": "dateRange",
    "config": {}
  },
  {
    "id": "region-select",
    "name": "Region Selector",
    "type": "select",
    "config": {}
  }
]

Use Case:

Get available input types when defining report parameters.

---

GET /api/reports/{id}/input-filter-templates

Get available input filter templates for a report.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Report ID

Response:

Returns an array of filter template definitions.

[
  {
    "id": "field-filter",
    "name": "Field Filter",
    "type": "filter",
    "config": {}
  }
]

Use Case:

Get available filter UI components when building report inputs.