[]
        
(Showing Draft Content)

VizTemplate

VizTemplate

[POST] /api/v2/dashboard/vizTemplates

Response

Status Code: 201

Created

VizTemplateResponse

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[DELETE] /api/v2/dashboard/vizTemplates/{id}

Delete Viz Template

Parameters

Name Type Located In Description
idRequired string path vizTemplate id

Response

Status Code: 200

Success

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[GET] /api/v2/dashboard/vizTemplates/{id}

Get Viz Template

Parameters

Name Type Located In Description
idRequired string path viz template id
rev int32 query dashboard revision

Response

Status Code: 200

Success

VizTemplateViewModel

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

Models

Ƭ VizTemplateResponse

VizTemplate POST Response

Name Type Description Example
vizTemplateIdNullable string New Scene ID

Ƭ ServerPluginError

Server plugin error

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

Ƭ VizTemplateViewModel

Name Type Description Example
idNullable string
titleNullable string
contentNullable any
versionNullable string
commentNullable string
sharedResourcesNullable SharedResource

Ƭ SharedResource

Name Type Description Example
idNullable string
type DocumentType

Ƭ DocumentType

Enum:

  • Unknown
  • Dashboard
  • Dataset
  • DataSource
  • Image
  • Theme
  • MapHierarchy
  • GeoJson
  • Report
  • Visual
  • FloorPlan
  • AnalysisModel
  • Font
  • LanguageResource
  • NativeQuery
  • Scene
  • Glb
  • DashboardTemplate
  • VizTemplate