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

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。

相关文章

MyBatis Plus 中 update_time 字段自动填充失效的原因分析及解决方案(最新整理)

MyBatis Plus 中 update_time 字段自动填充失效的原因分析及解决方案(最新整理)

《MyBatisPlus中update_time字段自动填充失效的原因分析及解决方案(最新整理)》在使用MyBatisPlus时,通常我们会在数据库表中设置create_time和update... 目录前言一、问题现象二、原因分析三、总结：常见原因与解决方法对照表四、推荐写法前言在使用 MyBATis
阅读更多...
Python主动抛出异常的各种用法和场景分析

Python主动抛出异常的各种用法和场景分析

《Python主动抛出异常的各种用法和场景分析》在Python中,我们不仅可以捕获和处理异常,还可以主动抛出异常,也就是以类的方式自定义错误的类型和提示信息,这在编程中非常有用,下面我将详细解释主动抛... 目录一、为什么要主动抛出异常？二、基本语法：raise关键字基本示例三、raise的多种用法1. 抛
阅读更多...
github打不开的问题分析及解决

github打不开的问题分析及解决

《github打不开的问题分析及解决》：本文主要介绍github打不开的问题分析及解决,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、找到github.com域名解析的ip地址二、找到github.global.ssl.fastly.net网址解析的ip地址三
阅读更多...
Mysql的主从同步/复制的原理分析

Mysql的主从同步/复制的原理分析

《Mysql的主从同步/复制的原理分析》：本文主要介绍Mysql的主从同步/复制的原理分析,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录为什么要主从同步？mysql主从同步架构有哪些？Mysql主从复制的原理/整体流程级联复制架构为什么好？Mysql主从复制注意
阅读更多...
java -jar命令运行 jar包时运行外部依赖jar包的场景分析

java -jar命令运行 jar包时运行外部依赖jar包的场景分析

《java-jar命令运行jar包时运行外部依赖jar包的场景分析》：本文主要介绍java-jar命令运行jar包时运行外部依赖jar包的场景分析,本文给大家介绍的非常详细,对大家的学习或工作... 目录Java -jar命令运行 jar包时如何运行外部依赖jar包场景：解决：方法一、启动参数添加： -Xb
阅读更多...
Apache 高级配置实战之从连接保持到日志分析的完整指南

Apache 高级配置实战之从连接保持到日志分析的完整指南

《Apache高级配置实战之从连接保持到日志分析的完整指南》本文带你从连接保持优化开始,一路走到访问控制和日志管理,最后用AWStats来分析网站数据,对Apache配置日志分析相关知识感兴趣的朋友... 目录Apache 高级配置实战：从连接保持到日志分析的完整指南前言 一、Apache 连接保持 - 性
阅读更多...
Linux中的more 和 less区别对比分析

Linux中的more 和 less区别对比分析

《Linux中的more和less区别对比分析》在Linux/Unix系统中,more和less都是用于分页查看文本文件的命令,但less是more的增强版,功能更强大,：本文主要介绍Linu... 目录1. 基础功能对比2. 常用操作对比less 的操作3. 实际使用示例4. 为什么推荐 less？5.
阅读更多...
spring-gateway filters添加自定义过滤器实现流程分析(可插拔)

spring-gateway filters添加自定义过滤器实现流程分析(可插拔)

《spring-gatewayfilters添加自定义过滤器实现流程分析(可插拔)》：本文主要介绍spring-gatewayfilters添加自定义过滤器实现流程分析(可插拔),本文通过实例图... 目录需求背景需求拆解设计流程及作用域逻辑处理代码逻辑需求背景公司要求，通过公司网络代理访问的请求需要做请
阅读更多...
Java集成Onlyoffice的示例代码及场景分析

Java集成Onlyoffice的示例代码及场景分析

《Java集成Onlyoffice的示例代码及场景分析》：本文主要介绍Java集成Onlyoffice的示例代码及场景分析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 需求场景：实现文档的在线编辑，团队协作总结：两个接口 + 前端页面 + 配置项接口1：一个接口，将o
阅读更多...
IDEA下"File is read-only"可能原因分析及"找不到或无法加载主类"的问题

IDEA下"File is read-only"可能原因分析及"找不到或无法加载主类"的问题

《IDEA下Fileisread-only可能原因分析及找不到或无法加载主类的问题》：本文主要介绍IDEA下Fileisread-only可能原因分析及找不到或无法加载主类的问题,具有很好的参... 目录1.File is read-only”可能原因2.“找不到或无法加载主类”问题的解决总结1.File
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2