Reporting-ExportTemplates
Reporting-ExportTemplates
[POST] /api/v2/reporting/export-templates
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/reporting/export-templates
Response
Status Code: 200
Success
ExportTemplateSettingsResponse
[PUT] /api/v2/reporting/export-templates/{exportTemplateId}
Parameters
| Name | Type | Located In |
|---|---|---|
| exportTemplateIdRequired | string | path |
Request Schema
Response
Status Code: 204
Success
Status Code: 400
Bad Request
[DELETE] /api/v2/reporting/export-templates/{exportTemplateId}
Parameters
| Name | Type | Located In |
|---|---|---|
| exportTemplateIdRequired | string | path |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/reporting/export-templates/count
Response
Status Code: 200
Success
[GET] /api/v2/reporting/export-templates/{targetPlaces}
Parameters
| Name | Type | Located In |
|---|---|---|
| targetPlacesRequired | string | path |
Response
Status Code: 200
Success
ExportTemplateSettingsResponse
Status Code: 400
Bad Request
Models
Ƭ ExportTemplateAddResponse
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string |
Ƭ ReportingPluginError
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | ||
| messageNullable | string | ||
| contextNullable | string |
Ƭ ExportTemplateSettingsRequest
| Name | Type | Description | Example |
|---|---|---|---|
| description | string | ||
| exportType | ExportType | ||
| name | string | ||
| roles | Array<string> |
||
| targetPlaces | TargetPlaces | ||
| exportSettings | any | ||
| allowedSettings | Boolean | ||
| index | int32 |
Ƭ ExportType
Enum:
PdfExcelExceldataDocxCsvHtmlImageJsonTxtXml
Export format type.
* 'Pdf' - 0 - PDF export type.
* 'Excel' - 1 - Excel export type.
* 'Exceldata' - 2 - Exceldata export type.
* 'Docx' - 3 - Docx export type.
* 'Csv' - 4 - CSV export type.
* 'Html' - 5 - Html export type.
* 'Image' - 6 - Image export type.
* 'Json' - 7 - Json export type.
* 'Txt' - 8 - Text export type.
* 'Xml' - 9 - XML export type.
Ƭ TargetPlaces
Enum:
NoneAPISchedulerViewerPortalAll
The target place type.
* 'None' - 0 - No target.
* 'API' - 1 - Target API.
* 'scheduler' - 2 - Target scheduler.
* 'Viewer' - 3 - Target viewer.
* 'Portal' - 4 - Target portal.
* 'All' - 5 - Target all.
Ƭ ExportTemplateSettingsResponse
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | ||
| descriptionNullable | string | ||
| exportTypeNullable | string | ||
| nameNullable | string | ||
| rolesNullable | Array<string> |
||
| targetPlaces | TargetPlaces | ||
| exportSettingsNullable | any | ||
| allowedSettingsNullable | Boolean | ||
| index | int32 |
Ƭ ExportTemplateCountResponse
| Name | Type | Description | Example |
|---|---|---|---|
| count | int32 |