Skip to content

通用接口

通用数据查询接口

衡石系统提供了通用的数据查询接口,返回结果是数据集数据 datasetResultDto

用 HE 表达式查询数据

请求URL

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

请求参数

URL 参数
字段类型说明
limitNUMBER可选,返回记录的最大条数,默认是1000
offsetNUMBER可选,返回第几页数据,默认是0
Request Body 参数

HE 表达式,详情参照HE 的数据集函数

返回对象的格式说明

数据集数据 datasetResultDto

参考示例

http
POST /api/data/query?limit=1 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
	"kind":"formula",
	"op":"summarize(app_dataset(1, 1), {type}, sum({votes}) as 'sum1')"
}
http
HTTP/1.1 200 Ok
Content-Type: application/json

{
    "version": "version@9a5e106#6730f0d",
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            [
                "喜剧",
                16.5,
                8.3
            ]
        ],
        "schema": [
            {
                "fieldName": "type",
                "visible": true,
                "nativeType": "text"
            },
            {
                "fieldName": "sum1",
                "visible": true,
                "nativeType": "numeric"
            },
            {
                "fieldName": "max1",
                "visible": true,
                "nativeType": "numeric"
            }
        ]
    }
}

通用对象查询接口

衡石提供了通用的对象查询接口。

请求URL

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

请求参数

URL 参数

字段类型是否必选说明
typeSTRING搜索对象类型,目前支持 app, connection, dataset, chart
connectionTypeSTRING数据连接所对应的数据源类型,比如 postgresql
qSTRING搜索关键词
appIdNUMBERappid
publishTypeSTRING是否发布(仅 app)
pOrCByCurrentBOOL是否仅查询由当前用户发布的数据
createdByCurrentBOOL是否仅查询由当前用户创建的数据
authBOOL是否仅查询其他用户授权给当前用户的
showHideBOOL是否返回被用户隐藏的 app,默认值 false
orderBySTRING指定排序列
orderTypeSTRING指定排序顺序 ASC,DESC
areaSTRING指定 app 的查询区域
queryAllBOOL是否查询所有有权限的应用,默认值 false
queryPlatformBOOL是否只查询平台数据

返回结果

字段类型描述
connectionOBJECT数据连接返回结果
connection.dataOBJECT 数组数据连接结果数组,参考数据连接数据结构
connection.offsetNUMBER偏移量
connection.totalHitsNUMBER结果总条数
appOBJECT应用返回结果
app.dataOBJECT 数组应用结果数组,参考应用数据结构
app.offsetNUMBER偏移量
app.totalHitsNUMBER结果总条数
chartOBJECT图表返回结果
chart.dataOBJECT 数组图表结果数组,参考图表数据结构
chart.offsetNUMBER偏移量
chart.totalHitsNUMBER结果总条数
datasetOBJECT数据集返回结果
dataset.dataOBJECT 数组数据集结果数组,参考数据集数据结构
dataset.offsetNUMBER偏移量
dataset.totalHitsNUMBER结果总条数

参考示例

http
GET /api/search?type=dataset&q=a%20a&appId=134200&offset=0&limit=1000 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...
http
HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "5.3-SNAPSHOT@1ecab8f#54c5095",
  "code": 0,
  "msg": "success",
  "data": {
    "dataset": {
      "data": [
        {
          "id": 8,
          "title": "agg",
          "createdBy": 27226,
          "createdAt": "2023-07-27 10:09:55",
          "updatedBy": 27226,
          "updatedAt": "2024-08-07 09:30:17",
          "visible": true,
          "isDelete": false,
          "appId": 128784,
          "entityGroup": "DATASET",
          "entityKey": "128784-8",
          "emptyDataset": false,
          "type": "aggregate"
        }
      ],
      "offset": 0,
      "totalHits": 3
    }
  },
  "chartDataStartTimeMillis": 0
}

HENGSHI SENSE API 使用手册