VizTemplate
VizTemplate
[POST] /api/v2/dashboard/vizTemplates
Response
Status Code: 201
Created
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[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
Status Code: 403
Forbidden
Status Code: 404
Not Found
[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
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
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:
UnknownDashboardDatasetDataSourceImageThemeMapHierarchyGeoJsonReportVisualFloorPlanAnalysisModelFontLanguageResourceNativeQuerySceneGlbDashboardTemplateVizTemplate