主题
DTS Charts API
DTS Charts支持嵌入到其他第三方系统中。通过以下API，可以对Charts进行定制化的开发。
注意： Charts根据部署环境分为网络版本和本地版本。 部分接口有版本限制。
新增大屏工程
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/scene/template/insert/v1
请求方式
pots
请求格式
from-data
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| name | String | 否 | 大屏名称（默认为当前时间YYYMMDDHHMMSS） |
| preview | 文件流（file） | 否 | 大屏缩略图 |
| remark | String | 否 | 备注信息 |
| topic | String | 否 | 主题 |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | String | 项目ID |
返回样例
{
"state": {
"code": 10000,
"message": "访问成功",
"timestamp": 1687328713531
},
"body": {
"message": "5147d4c1-613a-41f4-a47d-5cade86b44ee"
}
}
删除大屏工程
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/scene/template/delete
请求方式
pots
请求格式
from-data或x-www-from-urlencoded
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| id | String | 是 | 项目ID |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | String | 错误信息 |
返回样例
{
"state": {
"code": 10000,
"message": "访问成功",
"timestamp": 1687328713531
},
"body": {
"message": "5147d4c1-613a-41f4-a47d-5cade86b44ee"
}
}
复制大屏工程
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/scene/template/copy
请求方式
pots
请求格式
from-data或x-www-from-urlencoded
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| id | String | 是 | 复制项目ID |
| name | String | 是 | 新项目的名称 |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | String | 错误信息 |
编辑指定大屏项目
请求地址
http://127.0.0.1:34669/\#/LoginExplorer?id=dbdfe083-7576-4c48-8208-df04776bd589&layout=1
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| id | String | 是 | 项目ID |
| layout | String | 否 | 1 固定布局（默认） 3 自适应布局 |
返回信息
预览页面
预览大屏
请求地址
http://127.0.0.1:34669/\#/viewer?id=dbdfe083-7576-4c48-8208-df04776bd589&token=DTSCHARTS&viewer=1
请求页面地址
注意： 分享后的ID进行预览，请去掉token
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| id | String | 是 | 项目ID |
| viewer | String | 是 | 写死 1 |
返回信息
预览页面
大屏项目输出
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/access/dtscharts/download/v1
请求方式
get
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| id | String | 是 | 项目ID |
| path | String | 是 | 支持两种 文件存放路径 比如：d:/a.zip或者d:/ |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | String | 错误信息 |
返回样例
{
"state": {
"code": 10000,
"message": "访问成功",
"timestamp": 1687329443425
},
"body": {
"message": "1"
}
}
大屏项目导入
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/scene/resource/upload
此接口支持断点续传
请求方式
post
请求格式
from-data
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【dtscharts_upload】，大小写不限 |
| file | 文件流（file） | 是 | 文件 |
| filename | String | 是 | 文件名，完整文件名带后缀：如 aa.zip |
| start | 整数 | 是 | 开始文件大小 |
| end | 整数 | 是 | 结束文件大小 |
| size | 整数 | 是 | 文件大小 |
| type | 4 | 是 | 写死4 |
| attribute | json字符串 | 是 | {"chartset":"GBK"} 写死 |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | json | 错误信息 |
| body.message.id | String | 返回ID。无返回ID代表读取zip失败 |
| body.message,state | String | 状态 1成功，其他续传 |
返回样例
{
"state": {
"code": 10000,
"message": "访问成功",
"timestamp": 1688543139702
},
"body": {
"message": {
"id": "569e37fa-cf2f-4ee4-8628-9e684f93af52",
"state": "1"
}
}
}
大屏分享预览
注意： 仅支持网络版本
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/share/insert
此接口支持断点续传
请求方式
post
请求格式
from-data
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【dtscharts】，大小写不限 |
| layerid | String | 是 | 项目ID |
| name | String | 是 | 分享名称 |
| expiretime | String | 是 | 失效时间： 2023-11-30 12:00:00 必须安装这种格式上送 |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | String | 分享ID,用于预览(预览，参照项目预览) |
返回样例
{
"state": {
"code": 10000,
"message": "访问成功",
"timestamp": 1701157238297
},
"body": {
"message": "Jt6hqPaRDbH6QJrIlef54dThECT2i2IAbCrVLloHPqDYt4SJ1u4dDfc3Xk7aRIVN0MmP1s8dU0fzIpfra7szDspzlVIYqMXMAUmm"
}
}
项目信息查询
请求地址
http://127.0.0.1:34669/FreedoDtsSceneSvc/service/access/dtscharts/size
请求方式
get
请求参数
| 参数 | 赋值类型 | 是否必输 | 备注 |
|---|---|---|---|
| token | String | 是 | 直接写死为【DTSCHARTS】，大小写不限 |
| id | String | 是 | 项目ID |
返回信息
| 参数 | 赋值类型 | 备注 |
|---|---|---|
| state | json | 执行结果 |
| state.code | String | 返回码 10000成功，其他失败 |
| state.timestamp | long | 返回时间戳 |
| body | json | 返回主题信息 |
| body.message | json | 返回项目资源信息 |
| body.message.projectsize | long | 项目资源大小 |
| body.message.pagesize | int | 项目页数 |
返回样例
{"state":{"code":10000,"message":"访问成功","timestamp":1701337050479},"body":{"message":{"projectsize":277752,"pagesize":2}}}