[]
(Showing Draft Content)

Reporting-ExportTemplates

Reporting-ExportTemplates

[POST] /api/v2/reporting/export-templates

Adds a new export template.

Request Body

Description: Export template settings request model.

Type: application/json

ExportTemplateSettingsRequest

Responses

[200] Success

ExportTemplateAddResponse

Type: [application/json]

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[GET] /api/v2/reporting/export-templates

Gets list of export templates.

Responses

[200] Success

ExportTemplateSettingsResponse

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[PUT] /api/v2/reporting/export-templates/{exportTemplateId}

Parameters

Name In Type Description
exportTemplateIdRequired path string Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295

Updates the export template.

Request Body

Description: Export template settings request model.

Type: application/json

ExportTemplateSettingsRequest

Responses

[204] No Content

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[DELETE] /api/v2/reporting/export-templates/{exportTemplateId}

Parameters

Name In Type Description
exportTemplateIdRequired path string Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295

Deletes the export template.

Responses

[200] Success

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[GET] /api/v2/reporting/export-templates/count

Gets count of export templates.

Responses

[200] Success

ExportTemplateCountResponse

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[GET] /api/v2/reporting/export-templates/{targetPlaces}

Parameters

Name In Type Description
targetPlacesRequired path string Acceptable values: API, Scheduler, Viewer, Portal, All and their combinations, separated by commas.

Gets list of export template settings by target place(s).

Responses

[200] Success

ExportTemplateSettingsResponse

Type: [application/json]

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

Models

Ƭ ExportTemplateAddResponse

Add export template response model.

Name Type Description
idNullable string Export template id.

Ƭ ReportingPluginError

Reporting plugin error

Name Type Description
codeNullable string error code
messageNullable string error message
contextNullable string error context

Ƭ ExportTemplateSettingsRequest

Export template settings request model.

Name Type Description Example
descriptionRequired string Description of the export template.
exportTypeRequired ExportType
nameRequired string Name of the export template.
rolesRequired Array<string> Roles for which the export template is available. ["Everyone"]
targetPlacesRequired TargetPlaces
exportSettingsRequired any Export settings. {"Version":"Pdf14","Title":"Example title"}
allowedSettingsRequired Boolean Allowed settings. {"Version":true,"Author":true}
indexRequired int32 Sorting index. 1
icon ExportTemplateIcon

Ƭ ExportType

Enum:

  • Pdf

  • Excel

  • Exceldata

  • Docx

  • Csv

  • Html

  • Image

  • Json

  • Txt

  • Xml

    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:

  • None

  • API

  • Scheduler

  • Viewer

  • Portal

  • All

    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

Ƭ ExportTemplateIcon

Export template icon model.

Name Type Description
typeNullable string Export template icon type.
nameNullable string Export template icon name.
colorNullable string Export template icon color.
valueNullable string Export template custom icon value.

Ƭ ExportTemplateSettingsResponse

Export template settings response model.

Name Type Description
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.
icon ExportTemplateIcon

Ƭ ExportTemplateCountResponse

Count of export templates response model.

Name Type Description
count int32 Count of export templates.