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

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。

相关文章

Spring事务中@Transactional注解不生效的原因分析与解决

Spring事务中@Transactional注解不生效的原因分析与解决

《Spring事务中@Transactional注解不生效的原因分析与解决》在Spring框架中,@Transactional注解是管理数据库事务的核心方式,本文将深入分析事务自调用的底层原理,解释为... 目录1. 引言2. 事务自调用问题重现2.1 示例代码2.2 问题现象3. 为什么事务自调用会失效3
阅读更多...
找不到Anaconda prompt终端的原因分析及解决方案

找不到Anaconda prompt终端的原因分析及解决方案

《找不到Anacondaprompt终端的原因分析及解决方案》因为anaconda还没有初始化,在安装anaconda的过程中,有一行是否要添加anaconda到菜单目录中,由于没有勾选,导致没有菜... 目录问题原因问http://www.chinasem.cn题解决安装了 Anaconda 却找不到 An
阅读更多...
Spring定时任务只执行一次的原因分析与解决方案

Spring定时任务只执行一次的原因分析与解决方案

《Spring定时任务只执行一次的原因分析与解决方案》在使用Spring的@Scheduled定时任务时,你是否遇到过任务只执行一次,后续不再触发的情况？这种情况可能由多种原因导致,如未启用调度、线程... 目录1. 问题背景2. Spring定时任务的基本用法3. 为什么定时任务只执行一次？3.1 未启用
阅读更多...
C++ 各种map特点对比分析

C++ 各种map特点对比分析

《C++各种map特点对比分析》文章比较了C++中不同类型的map（如std::map,std::unordered_map,std::multimap,std::unordered_multima... 目录特点比较C++ 示例代码 ​​​​​​代码解释特点比较1. std::map底层实现：基于红黑
阅读更多...
Spring、Spring Boot、Spring Cloud 的区别与联系分析

Spring、Spring Boot、Spring Cloud 的区别与联系分析

《Spring、SpringBoot、SpringCloud的区别与联系分析》Spring、SpringBoot和SpringCloud是Java开发中常用的框架,分别针对企业级应用开发、快速开... 目录1. Spring 框架2. Spring Boot3. Spring Cloud总结1. Sprin
阅读更多...
Spring 中 BeanFactoryPostProcessor 的作用和示例源码分析

Spring 中 BeanFactoryPostProcessor 的作用和示例源码分析

《Spring中BeanFactoryPostProcessor的作用和示例源码分析》Spring的BeanFactoryPostProcessor是容器初始化的扩展接口,允许在Bean实例化前... 目录一、概览1. 核心定位2. 核心功能详解3. 关键特性二、Spring 内置的 BeanFactory
阅读更多...
MyBatis-Plus中Service接口的lambdaUpdate用法及实例分析

MyBatis-Plus中Service接口的lambdaUpdate用法及实例分析

《MyBatis-Plus中Service接口的lambdaUpdate用法及实例分析》本文将详细讲解MyBatis-Plus中的lambdaUpdate用法,并提供丰富的案例来帮助读者更好地理解和应... 目录深入探索MyBATis-Plus中Service接口的lambdaUpdate用法及示例案例背景
阅读更多...
MyBatis-Plus中静态工具Db的多种用法及实例分析

MyBatis-Plus中静态工具Db的多种用法及实例分析

《MyBatis-Plus中静态工具Db的多种用法及实例分析》本文将详细讲解MyBatis-Plus中静态工具Db的各种用法,并结合具体案例进行演示和说明,具有很好的参考价值,希望对大家有所帮助,如有... 目录MyBATis-Plus中静态工具Db的多种用法及实例案例背景使用静态工具Db进行数据库操作插入
阅读更多...
Go使用pprof进行CPU,内存和阻塞情况分析

Go使用pprof进行CPU,内存和阻塞情况分析

《Go使用pprof进行CPU,内存和阻塞情况分析》Go语言提供了强大的pprof工具,用于分析CPU、内存、Goroutine阻塞等性能问题,帮助开发者优化程序,提高运行效率,下面我们就来深入了解下... 目录1. pprof 介绍2. 快速上手：启用 pprof3. CPU Profiling：分析 C
阅读更多...
MySQL表锁、页面锁和行锁的作用及其优缺点对比分析

MySQL表锁、页面锁和行锁的作用及其优缺点对比分析

《MySQL表锁、页面锁和行锁的作用及其优缺点对比分析》MySQL中的表锁、页面锁和行锁各有特点,适用于不同的场景,表锁锁定整个表,适用于批量操作和MyISAM存储引擎,页面锁锁定数据页,适用于旧版本... 目录1. 表锁（Table Lock）2. 页面锁（Page Lock）3. 行锁（Row Lock
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2