通用接口

通用数据查询接口

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

用 HE 表达式查询数据

请求URL

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

请求参数

URL 参数

字段	类型	说明
limit	NUMBER	可选，返回记录的最大条数，默认是1000
offset	NUMBER	可选，返回第几页数据，默认是0

Request Body 参数

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

返回对象的格式说明

数据集数据 datasetResultDto

参考示例

Request

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')"
}

Response

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

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

请求参数

URL 参数

字段	类型	是否必选	说明
type	STRING	是	搜索对象类型，目前支持 app, connection, dataset, chart
connectionType	STRING	否	数据连接所对应的数据源类型，比如 postgresql
q	STRING	是	搜索关键词
appId	NUMBER	否	app 的 id
publishType	STRING	否	是否发布（仅 app)
pOrCByCurrent	BOOL	否	是否仅查询由当前用户发布的数据
createdByCurrent	BOOL	否	是否仅查询由当前用户创建的数据
auth	BOOL	否	是否仅查询其他用户授权给当前用户的
showHide	BOOL	是	是否返回被用户隐藏的 app，默认值 false
orderBy	STRING	否	指定排序列
orderType	STRING	否	指定排序顺序 ASC,DESC
area	STRING	否	指定 app 的查询区域
queryAll	BOOL	是	是否查询所有有权限的应用，默认值 false
queryPlatform	BOOL	否	是否只查询平台数据

返回结果

字段	类型	描述
connection	OBJECT	数据连接返回结果
connection.data	OBJECT 数组	数据连接结果数组，参考数据连接数据结构
connection.offset	NUMBER	偏移量
connection.totalHits	NUMBER	结果总条数
app	OBJECT	应用返回结果
app.data	OBJECT 数组	应用结果数组，参考应用数据结构
app.offset	NUMBER	偏移量
app.totalHits	NUMBER	结果总条数
chart	OBJECT	图表返回结果
chart.data	OBJECT 数组	图表结果数组，参考图表数据结构
chart.offset	NUMBER	偏移量
chart.totalHits	NUMBER	结果总条数
dataset	OBJECT	数据集返回结果
dataset.data	OBJECT 数组	数据集结果数组，参考数据集数据结构
dataset.offset	NUMBER	偏移量
dataset.totalHits	NUMBER	结果总条数

参考示例

Request

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...

Response

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
}