数据查询接口

scope:hades:datasheet:list

search节点详细说明：

fieldId：参考接口30查询表单字段信息 [itemId]

value：当字段的类型是文本，数值，日期时，搜索的值

express：当字段id的类型是单选或者多选填写[incl]
‒ 字段为文本：match
‒ 字段为单选或多选：incl
‒ 字段为数值：≠，≥，>，=，≤，<
‒ 字段为日期：≥，≤

selections：当字段的类型是单选或者多选，搜索的值

接口作用

查询指定表单的数据记录，支持分页、排序和搜索。底层调用Klee表单平台接口。

接口信息

属性	值
URL	`/open/api/v1/datasheet/record/list`
Method	POST
Content-Type	application/json
权限标识	`hades:datasheet:list`

请求参数

参数名	类型	必填	说明
corpId	String	是	企业ID
dstId	String	是	表单ID
sorts	List<SortField>	否	排序条件，默认为空列表
search	List<Condition>	否	搜索条件，默认为空列表
page	Integer	否	页码，默认为1
pageSize	Integer	否	每页大小，默认为30

请求示例:

{
  "corpId": "corp_123456",
  "dstId": "dst_001",
  "sorts": [
    {
      "field": "createTime",
      "order": "desc"
    }
  ],
  "search": [
    {
      "fieldId": "recId",
      "express": "=",
      "selections": ["recr5qktm9uykf45blq204q97a2","recv2jr38moy6dh3381zruhk7o0"]
    }
  ],
  "page": 1,
  "pageSize": 30
}

返回参数

参数名	类型	说明
success	Boolean	是否成功
errorCode	String	错误码
errorMsg	String	错误信息
rid	String	链路追踪ID
data	DatasheetRecords	Klee平台返回的表单数据记录对象

返回示例:

{
  "success": true,
  "errorCode": null,
  "errorMsg": null,
  "rid": "trace_001",
  "data": {
    "total": 100,
    "records": [
      {
        "recId": "rec_001",
        "dstId": "xxx",
        "fieldName1": "value1",
        "fieldName2": "value2"
      }
    ]
  }
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

示例

{
  "app": "venus",
  "corpId": "ding4c7c311a701851ac35c2f4657eb6378f",
  "dstId": "dsth6uhsa6a0k7ub23",
  "search": [],
  "page": 1,
  "pageSize": 30
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "data": {
        "records": [
            {
                "fld_textztwh4wpjlu": "西伯利亚",
                "dstId": "dsth6uhsa6a0k7ub23",
                "fld_text6t894hmna9": "mike",
                "fld_datevzrybwq55r": "2024-07-27",
                "fld_numberev8swsd4kv": 20,
                "recId": "reclwrg3qh0oyidg2se0s87arsi"
            },
            {
                "fld_textztwh4wpjlu": "北京",
                "dstId": "dsth6uhsa6a0k7ub23",
                "fld_text6t894hmna9": "张三",
                "fld_datevzrybwq55r": "2024-07-11",
                "fld_numberev8swsd4kv": 18,
                "recId": "reckf40t56gud9ekrmg8ubzm1s9"
            }
        ],
        "total": 2
    },
    "errorMsg": "成功",
    "success": true
}

接口作用#

接口信息#

请求参数#

返回参数#

请求参数

请求示例代码

返回响应

接口作用

接口信息

请求参数

返回参数