v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Report Templates

Endpoints to manage and export report templates

Operations

GET/api/v2/report/templatesPOST/api/v2/report/templatesGET/api/v2/report/templates/ticket-basic-info-fieldsGET/api/v2/report/templates/{id}DELETE/api/v2/report/templates/{id}PATCH/api/v2/report/templates/{id}POST/api/v2/report/templates/{id}/duplicatePOST/api/v2/report/templates/bulk-deleteGET/api/v2/report/templates/export

---

Get report templates

GET

/api/v2/report/templates

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Report template list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/report/templates

Playground

Authorization

bearerAuth

Samples

---

Create a report template

POST

/api/v2/report/templates

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Report template created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/report/templates

Playground

Authorization

bearerAuth

Body

Samples

---

List Basic Info field keys and default labels for report templates

GET

/api/v2/report/templates/ticket-basic-info-fields

Returns the same field list as the admin export manager Basic Info picker. When USAT is enabled for the site, USAT-only fields are included at the end.

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Field list

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/report/templates/ticket-basic-info-fields

Playground

Authorization

bearerAuth

Samples

---

Get report template by ID

GET

/api/v2/report/templates/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Format

"int64"

Responses

Report template

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/report/templates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete a report template

DELETE

/api/v2/report/templates/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Format

"int64"

Responses

Report template deleted

DELETE

/api/v2/report/templates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update a report template

PATCH

/api/v2/report/templates/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Report template updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/report/templates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Duplicate a report template

POST

/api/v2/report/templates/{id}/duplicate

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Format

"int64"

Responses

Duplicated report template

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/report/templates/{id}/duplicate

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Bulk delete report templates

POST

/api/v2/report/templates/bulk-delete

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Report templates deleted

POST

/api/v2/report/templates/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Export data using selected report template(s)

GET

/api/v2/report/templates/export

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

emailAddress

Optional email address to notify when the export is ready

Type

string

Example"admin@example.com"

Format

"email"

Responses

Export result

Content-Type

application/json

"string"

GET

/api/v2/report/templates/export

Playground

Authorization

bearerAuth

Variables

Key

Value

emailAddress

Samples

---

Powered by VitePress OpenAPI