查询表单字段信息

scope: hades:datasheet:fieldList

接口作用

获取指定表单的字段定义信息，包括字段名称、字段ID和字段类型。

接口信息

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

请求参数

参数名	类型	必填	说明
corpId	String	是	企业ID
dstId	String	是	表单ID

请求示例:

{
  "corpId": "corp_123456",
  "dstId": "dst_001"
}

返回参数

参数名	类型	说明
success	Boolean	是否成功
errorCode	String	错误码
errorMsg	String	错误信息
rid	String	链路追踪ID
data	List<FieldResponse>	表单字段列表

FieldResponse 字段说明:

参数名	类型	说明
itemName	String	字段名称
itemId	String	字段ID
itemType	String	字段类型

返回示例:

{
  "success": true,
  "errorCode": null,
  "errorMsg": null,
  "rid": "trace_002",
  "data": [
    {
      "itemName": "姓名",
      "itemId": "fld_001",
      "itemType": "text"
    },
    {
      "itemName": "入职日期",
      "itemId": "fld_002",
      "itemType": "date"
    }
  ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "data": [
        {
            "itemId": "fld_text6t894hmna9",
            "itemName": "name",
            "itemType": "Input"
        },
        {
            "itemId": "fld_numberev8swsd4kv",
            "itemName": "age",
            "itemType": "InputNumber"
        },
        {
            "itemId": "fld_datevzrybwq55r",
            "itemName": "birthday",
            "itemType": "DatePicker"
        },
        {
            "itemId": "fld_textztwh4wpjlu",
            "itemName": "address",
            "itemType": "Input"
        }
    ],
    "errorMsg": "成功",
    "success": true
}

接口作用#

接口信息#

请求参数#

返回参数#

请求参数

请求示例代码

返回响应

接口作用

接口信息

请求参数

返回参数