[]
(Showing Draft Content)

ExportTemplate

ExportTemplate

[POST] /api/reporting/exporttemplates

Request Schema

ExportSettingTemplate

Response

Status Code: 200

Success

[GET] /api/reporting/exporttemplates

Response

Status Code: 200

Success

ExportSettingTemplate

[PUT] /api/reporting/exporttemplates/{id}

Parameters

Name Type Located In
idRequired string path

Request Schema

ExportSettingTemplate

Response

Status Code: 200

Success

[DELETE] /api/reporting/exporttemplates/{id}

Parameters

Name Type Located In
idRequired string path

Response

Status Code: 200

Success

boolean

[GET] /api/reporting/exporttemplates/count

Response

Status Code: 200

Success

int32

[GET] /api/reporting/exporttemplates/{targetPlaces}

Parameters

Name Type Located In
targetPlacesRequired string path

Response

Status Code: 200

Success

ExportSettingTemplate

[GET] /api/reporting/exporttemplates/migration

Response

Status Code: 200

Success

ExportSettingTemplate

Models

Ƭ ExportSettingTemplate

Name Type Description Example
idNullable string
descriptionNullable string
exportTypeNullable string
exportNameNullable string
rolesNullable Array<string>
targetPlaces TargetPlaces
exportSettingsNullable any
allowedSettingsNullable Boolean
index int32
icon ExportTemplateIcon

Ƭ TargetPlaces

Enum:

  • None
  • API
  • Scheduler
  • Viewer
  • Portal
  • All

Enumeration of places where the template is available.

Ƭ ExportTemplateIcon

Export template icon model.

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