衡石科技产品手册-指标分析

2024-09-01 20:44
文章标签 分析 产品 指标 科技 手册 衡石

本文主要是介绍衡石科技产品手册-指标分析，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

指标分析引用参考资料：指标分析​

资源说明​

看板的定义​

看板为新的resource, 展现形式与Dashboard一样，权限与App一样。在看板列表中可以看到我自己创建的和别人授权给我的。展示模式分卡片样式和列表样式。有搜索、排序、分类功能。

看板结构说明​
Kanban​
字段类型描述
idLONG看板id
folderIdLONG看板所在文件夹的id
areaSTRING看板所在区域，默认为SELF_SERVICE
titleSTRING看板的标题
createdByLONG看板创建者的userId
createdAtDATE看板创建时间
updatedByLONG看板更新者的userId
updatedAtDATE看板更新时间
hsVersionLONG可选，本次编辑的版本号，从0开始，修改前先GET待修改资源获取当前版本号，修改时带上刚刚获取的版本号，服务端会检查并发冲突。不带版本号不检查并发冲突
tenantIdLONG租户Id
optionsOBJECT看板配置信息
options.configOBJECT看板配置信息
options.config.versionLONG看板创建版本，与系统版本一致
options.layoutsMAP看板里的图表布局信息
KanbanDto​
字段类型描述
creatorOBJECT看板创建者信息
updaterOBJECT看板更新者信息
actionSTRING权限描述, admin-read-write是管理者权限，read-write是编辑者权限，read是查看者权限
isCollaboratedBOOLEAN是否协作
parentsOBJECT 数组看板所在的文件夹列表
menusLIST<MAP<STRING, STRING>>看板的三点菜单列表

接口说明​

1、新增看板​

请求URL​

http

POST /api/kanbans HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

看板结构说明

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT看板的共同结构见看板结构说明
接口示例​

RequestResponse

http

POST /api/kanbans HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"title": "新建看板","options": {"config": {"version": 4300},"layouts": {}}
}

2、复制看板​

请求URL​

http

POST /api/kanbans/{kanbanId}/duplicate HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

无

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT看板的共同结构见看板结构说明
接口示例​

RequestResponse

http

POST /api/kanbans/57/duplicate HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

3、获取看板中所有的图表数据​

请求URL​

http

POST /api/kanbans/{kanbanId}/data HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

图表结构说明 ChartDto数组

URL 参数​
字段类型是否必须说明
timeoutInteger否查询超时时间
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT图表数据，每种图表的共同结构见ChartDto结构说明
接口示例​

RequestResponse

http

POST /api/kanbans/25/data?timeout=3000 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
[{"cacheKey": "01GNXZK96N910XVNFSHPBAAB18","appId": 125783,"options": {"axes": [{"uid": "u125783_3_c10","label": "caseWhen","kind": "function","dataset": 3,"op": "group","args": [{"dataset": 3,"kind": "field","op": "c10"}],"datasetId": 3},{"appId": 125783,"uid": "u125783_3_c22","label": "jn1","kind": "measure","op": "c22","datasetId": 3}],"where": [],"having": [],"sort": [{"kind": "reference","op": "u125783_3_c22","direction": "desc","baseUid": "u125783_3_c10"}],"timebar": {"current": "dateExp","dateExp": "All Avaliable Date","dateRange": [],"show": false},"limit": 1000,"outerWhere": []},"queryString": {"refresh": false,"offset": 0}}
]

4、获取看板中单个图表数据​

请求URL​

http

POST /api/kanbans/{kanbanId}/chart-data HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

图表结构说明 ChartDto

URL 参数​
字段类型是否必须说明
refreshSTRING否是否强制刷新，取图表数据时，true表示不会用缓存，false表示可以使用缓存
enableSampleSTRING否enableSample为true的话，后端计算时对基础数据进行采样，每次运算只取前10000行
返回对象的格式说明​

数据集数据 datasetResultDto

接口示例​

RequestResponse

http

POST /api/apps/125783/chart-data HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"cacheKey": "01GRRANRV0Z8VA84MY52D3WB7F","options": {"where": [],"having": [],"outerWhere": [],"axes": [{"uid": "u_1697bb6ffb9592e7_v","kind": "field","op": "省/自治区","dataset": 3}],"sort": [{"baseUid": "u_1697bb6ffb9592e7_v","kind": "reference","op": "u_1697bb6ffb9592e7_v","direction": "asc"}]},"queryString": {"limit": 100000}
}

5、获取看板中的图表数据计数​

请求URL​

http

POST /api/kanbans/{kanbanId}/chart-data/count HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

图表结构说明 ChartDto

URL 参数​
字段类型是否必须说明
refreshSTRING否是否强制刷新，取图表数据时，true表示不会用缓存，false表示可以使用缓存
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
data.totalHitsINTEGER图表数据的总行数
接口示例​

RequestResponse

http

POST /api/kanbans/125783/chart-data/count HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"cacheKey": "01GRRANRV0Z8VA84MY52D3WB7F","options": {"where": [],"having": [],"outerWhere": [],"axes": [{"uid": "u_1697bb6ffb9592e7_v","kind": "field","op": "省/自治区","dataset": 3}],"sort": [{"baseUid": "u_1697bb6ffb9592e7_v","kind": "reference","op": "u_1697bb6ffb9592e7_v","direction": "asc"}]},"queryString": {"limit": 100000}
}

6、轮询获取看板中的图表数据​

请求URL​

http

POST /api/kanbans/{kanbanId}/poll-data HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

请求参数​
request body 请求体​

图表结构说明 ChartDto数组

URL 参数​
字段类型是否必须说明
originRequestIdSTRING是源请求Id
timeoutInteger否查询超时时间
返回对象的格式说明​

数据集数据 datasetResultDto

接口示例​

RequestResponse

http

POST /api/kanbans/25/poll-data HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
[{"cacheKey": "01GNXZK96N910XVNFSHPBAAB18","appId": 125783,"options": {"axes": [{"uid": "u125783_3_c10","label": "caseWhen","kind": "function","dataset": 3,"op": "group","args": [{"dataset": 3,"kind": "field","op": "c10"}],"datasetId": 3},{"appId": 125783,"uid": "u125783_3_c22","label": "jn1","kind": "measure","op": "c22","datasetId": 3}],"where": [],"having": [],"sort": [{"kind": "reference","op": "u125783_3_c22","direction": "desc","baseUid": "u125783_3_c10"}],"timebar": {"current": "dateExp","dateExp": "All Avaliable Date","dateRange": [],"show": false},"limit": 1000,"outerWhere": []},"queryString": {"refresh": false,"offset": 0}}
]

7、更新看板​

请求URL​

http

PUT /api/kanbans/{kanbanId} HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

请求参数​
request body 请求体​

看板结构说明

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT看板的共同结构见看板结构说明
接口示例​

RequestResponse

http

PUT /api/kanbans/59 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...// Request Body:
{"id": 59,"folderId": 0,"area": "SELF_SERVICE","title": "新建看板","options": {"config": {"version": 4300},"layouts": {"01GRT32MSJF75XDVYAZVDNJYMQ": {"i": "01GRT32MSJF75XDVYAZVDNJYMQ","x": 0,"y": 0,"w": 6,"h": 6,"moved": false,"static": false,"zIndex": 901,"type": "chart","version": 4300,"createdAt": "2023/2/9 11:21:33","updatedAt": "2023/2/9 11:21:33","measures": [{"enable": true,"appId": 126243,"datasetId": 32,"fieldName": "c1","labelPlaceholder": "日期"}],"dimensions": [],"filters": []}}},"createdBy": 11549,"createdAt": "2023-02-08 18:33:26","updatedBy": 11549,"updatedAt": "2023-02-08 18:33:26","isDelete": false
}

8、分页查询看板​

请求URL​

http

GET /api/kanbans HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

无

URL 参数​
字段类型是否必须说明
limitINTEGER否分页获取个数，默认是1000
offsetINTEGER否分页偏移量，默认是0
orderBySTRING否排序字段
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT看板的共同结构见看板结构说明
totalHitsINTEGER看板总数量
offsetINTEGER当前分页偏移量
接口示例​

RequestResponse

http

GET /api/kanbans HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

9、根据Id查询看板​

请求URL​

http

GET /api/kanbans/{kanbanId} HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

无

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT看板的共同结构见看板结构说明
接口示例​

RequestResponse

http

GET /api/kanbans/59 HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

10、根据Id删除看板​

请求URL​

http

DELETE /api/kanbans/{kanbanId} HTTP/1.1

请求参数​
request body 请求体​

无

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING成功返回 success
接口示例​

RequestResponse

http

DELETE /api/kanbans/59 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

11、导出看板数据​

请求URL​

http

POST /api/kanbans/{kanbanId}/async-download HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​
字段类型是否必须说明
chartOptionsOBJECT否图表配置
chartNamesOBJECT否图表名称
chartOuterWheresOBJECT否图表过滤条件
URL 参数​
字段类型是否必须说明
timeoutInteger否导出超时时间
返回对象的格式说明​

返回一个zip文件，文件名是看板的名称，解压后的excel文件中每个sheet对应一个图表的聚合数据

12、轮询导出看板数据​

请求URL​

http

GET /api/kanbans/{kanbanId}/poll-download HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
request body 请求体​

无

URL 参数​
字段类型是否必须说明
originRequestIdSTRING是源请求Id
返回对象的格式说明​

如果导出任务没有完成，返回PENDING状态；若任务已完成，返回一个zip文件，文件名是看板的名称，解压后的excel文件中每个sheet对应一个图表的聚合数据

13、解除协作​

请求URL​

http

DELETE /api/kanbans/{kanbanId}/collaborate/cancel HTTP/1.1

1

请求参数​
request body 请求体​

无

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING成功返回 success
接口示例​

RequestResponse

http

DELETE /api/kanbans/59/collaborate/cancel HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

这篇关于衡石科技产品手册-指标分析的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1128003。

相关文章

Nginx分布式部署流程分析

Nginx分布式部署流程分析

《Nginx分布式部署流程分析》文章介绍Nginx在分布式部署中的反向代理和负载均衡作用,用于分发请求、减轻服务器压力及解决session共享问题,涵盖配置方法、策略及Java项目应用,并提及分布式事... 目录分布式部署NginxJava中的代理代理分为正向代理和反向代理正向代理反向代理Nginx应用场景
阅读更多...
Redis中的有序集合zset从使用到原理分析

Redis中的有序集合zset从使用到原理分析

《Redis中的有序集合zset从使用到原理分析》Redis有序集合(zset)是字符串与分值的有序映射,通过跳跃表和哈希表结合实现高效有序性管理,适用于排行榜、延迟队列等场景,其时间复杂度低,内存占... 目录开篇：排行榜背后的秘密一、zset的基本使用1.1 常用命令1.2 Java客户端示例二、zse
阅读更多...
Redis中的AOF原理及分析

Redis中的AOF原理及分析

《Redis中的AOF原理及分析》Redis的AOF通过记录所有写操作命令实现持久化,支持always/everysec/no三种同步策略,重写机制优化文件体积,与RDB结合可平衡数据安全与恢复效率... 目录开篇：从日记本到AOF一、AOF的基本执行流程1. 命令执行与记录2. AOF重写机制二、AOF的
阅读更多...
MyBatis Plus大数据量查询慢原因分析及解决

MyBatis Plus大数据量查询慢原因分析及解决

《MyBatisPlus大数据量查询慢原因分析及解决》大数据量查询慢常因全表扫描、分页不当、索引缺失、内存占用高及ORM开销,优化措施包括分页查询、流式读取、SQL优化、批处理、多数据源、结果集二次... 目录大数据量查询慢的常见原因优化方案高级方案配置调优监控与诊断总结大数据量查询慢的常见原因MyBAT
阅读更多...
分析 Java Stream 的 peek使用实践与副作用处理方案

分析 Java Stream 的 peek使用实践与副作用处理方案

《分析JavaStream的peek使用实践与副作用处理方案》StreamAPI的peek操作是中间操作,用于观察元素但不终止流,其副作用风险包括线程安全、顺序混乱及性能问题,合理使用场景有限... 目录一、peek 操作的本质：有状态的中间操作二、副作用的定义与风险场景1. 并行流下的线程安全问题2. 顺
阅读更多...
MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决

MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决

《MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决》MyBatis默认开启一级缓存,同一事务中循环调用查询方法时会重复使用缓存数据,导致获取的序列主键值均为1,... 目录问题原因解决办法如果是存储过程总结问题myBATis有如下代码获取序列作为主键IdMappe
阅读更多...
Java中最全最基础的IO流概述和简介案例分析

Java中最全最基础的IO流概述和简介案例分析

《Java中最全最基础的IO流概述和简介案例分析》JavaIO流用于程序与外部设备的数据交互,分为字节流（InputStream/OutputStream）和字符流（Reader/Writer）,处理... 目录IO流简介IO是什么应用场景IO流的分类流的超类类型字节文件流应用简介核心API文件输出流应用文
阅读更多...
Android 缓存日志Logcat导出与分析最佳实践

Android 缓存日志Logcat导出与分析最佳实践

《Android缓存日志Logcat导出与分析最佳实践》本文全面介绍AndroidLogcat缓存日志的导出与分析方法,涵盖按进程、缓冲区类型及日志级别过滤,自动化工具使用,常见问题解决方案和最佳实... 目录android 缓存日志（Logcat）导出与分析全攻略为什么要导出缓存日志？按需过滤导出1. 按
阅读更多...
Linux中的HTTPS协议原理分析

Linux中的HTTPS协议原理分析

《Linux中的HTTPS协议原理分析》文章解释了HTTPS的必要性：HTTP明文传输易被篡改和劫持,HTTPS通过非对称加密协商对称密钥、CA证书认证和混合加密机制,有效防范中间人攻击,保障通信安全... 目录一、什么是加密和解密？二、为什么需要加密？三、常见的加密方式3.1 对称加密3.2非对称加密四、
阅读更多...
MySQL中读写分离方案对比分析与选型建议

MySQL中读写分离方案对比分析与选型建议

《MySQL中读写分离方案对比分析与选型建议》MySQL读写分离是提升数据库可用性和性能的常见手段,本文将围绕现实生产环境中常见的几种读写分离模式进行系统对比,希望对大家有所帮助... 目录一、问题背景介绍二、多种解决方案对比2.1 原生mysql主从复制2.2 Proxy层中间件：ProxySQL2.3
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2