Reporting-ExportTemplates
Reporting-ExportTemplates
[POST] /api/v2/reporting/export-templates
Adds a new export template.
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
[GET] /api/v2/reporting/export-templates
Gets list of export templates.
Response
Status Code: 200
Success
ExportTemplateSettingsResponse
Status Code: 403
Forbidden
[PUT] /api/v2/reporting/export-templates/{exportTemplateId}
Updates the export template.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| exportTemplateIdRequired | string | path | Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295 |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 403
Forbidden
[DELETE] /api/v2/reporting/export-templates/{exportTemplateId}
Deletes the export template.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| exportTemplateIdRequired | string | path | Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295 |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
[GET] /api/v2/reporting/export-templates/count
Gets count of export templates.
Response
Status Code: 200
Success
Status Code: 403
Forbidden
[GET] /api/v2/reporting/export-templates/{targetPlaces}
Gets list of export template settings by target place(s).
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| targetPlacesRequired | string | path | Acceptable values: API, Scheduler, Viewer, Portal, All and their combinations, separated by commas. |
Response
Status Code: 200
Success
ExportTemplateSettingsResponse
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Models
Ƭ ExportTemplateAddResponse
Add export template response model.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | Export template id. |
Ƭ ReportingPluginError
Reporting plugin error
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | error code | |
| messageNullable | string | error message | |
| contextNullable | string | error context |
Ƭ ExportTemplateSettingsRequest
Export template settings request model.
| Name | Type | Description | Example |
|---|---|---|---|
| description | string | Description of the export template. | |
| exportType | ExportType | ||
| name | string | Name of the export template. | |
| roles | Array<string> |
Roles for which the export template is available. | ["Everyone"] |
| targetPlaces | TargetPlaces | ||
| exportSettings | any | Export settings. | {"Version":"Pdf14","Title":"Example title"} |
| allowedSettings | Boolean | Allowed settings. | {"Version":true,"Author":true} |
| index | int32 | Sorting index. | 1 |
Ƭ ExportType
Enum:
PdfExcelExceldataDocxCsvHtmlImageJsonTxtXml
Export type
* Pdf - 0 - PDF
* Excel - 1 - Excel
* Exceldata - 2 - Excel data
* Docx - 3 - Word
* Csv - 4 - CSV
* Html - 5 - HTML
* Image - 6 - Image
* Json - 7 - Json
* Txt - 8 - Txt
* Xml - 9 - XML
Ƭ TargetPlaces
Enum:
NoneAPISchedulerViewerPortalAll
Enumeration of places where the template is available.
* None - 0 - None
* API - 1 - API
* Scheduler - 2 - Scheduler
* Viewer - 4 - Viewer
* Portal - 8 - Portal
* All - 15 - All
Ƭ ExportTemplateSettingsResponse
Export template settings response model.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | Export template id. | |
| descriptionNullable | string | Description of the export template. | |
| exportTypeNullable | string | Export type of the export template. | |
| nameNullable | string | Name of the export template. | |
| rolesNullable | Array<string> |
Roles for which the export template is available. | |
| targetPlaces | TargetPlaces | ||
| exportSettingsNullable | any | Export settings. | |
| allowedSettingsNullable | Boolean | Allowed settings. | |
| index | int32 | Sorting index. |
Ƭ ExportTemplateCountResponse
Count of export templates response model.
| Name | Type | Description | Example |
|---|---|---|---|
| count | int32 | Count of export templates. |