- 首页
-
RESTful API
- 通用(Common)
- 账户(Identity)
- 账户-用户(Identity-User)
- 账户-角色(Identity-Role)
- 账户-组织(Identity-Organization)
- 仪表板(Dashboard)
- 仪表板-场景(Scene)
-
仪表板-可视化模板(VizTemplate)
- 共享资源(Shared-Resources)
- 数据-数据源(Datasource)
- 数据-数据集(Dataset)
- 数据-数据模型(DataModel)
- 文档-文档(Documents)
- 报表-预览(Reporting-RenderResults)
- 报表-报表(Reporting-Reports)
- 报表-缓存设置(Reporting-CachingSettings)
- 报表-导出模板(Reporting-ExportTemplates)
- 报表-自定义函数(Reporting-UserFunctions)
- JavaScript API
VizTemplate
VizTemplate
[POST] /api/v2/dashboard/vizTemplates
返回值
状态码: 201
已创建
状态码: 400
错误的请求
状态码: 403
禁止
状态码: 404
未找到
[DELETE] /api/v2/dashboard/vizTemplates/{id}
删除可视化模板
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 可视化模板id |
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 403
禁止
状态码: 404
未找到
[GET] /api/v2/dashboard/vizTemplates/{id}
获取可视化模板
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 可视化模板 ID |
| rev | int32 | query | 仪表板修订 |
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 403
禁止
状态码: 404
未找到
类型定义
Ƭ VizTemplateResponse
VizTemplate POST 响应
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| vizTemplateId可为空 | string | 新场景ID |
Ƭ ServerPluginError
服务器插件错误
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code可为空 | string | 错误代码 | |
| message可为空 | string | 错误信息 | |
| context可为空 | string | 错误上下文 |
Ƭ VizTemplateViewModel
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | ||
| title可为空 | string | ||
| content可为空 | any | ||
| version可为空 | string | ||
| comment可为空 | string | ||
| sharedResources可为空 | SharedResource |
Ƭ SharedResource
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | ||
| type | DocumentType |
Ƭ DocumentType
Enum:
UnknownDashboardDatasetDataSourceImageThemeMapHierarchyGeoJsonReportVisualFloorPlanAnalysisModelFontLanguageResourceNativeQuerySceneGlbDashboardTemplateVizTemplate