飞书项目帮助中心

Appearance

Return to top
页面导航

获取空间字段

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/template_list/:work_item_type_key
请求方式GET

请求 Header

字段值必须填写
Content-Typeapplication/json必须
X-PLUGIN-TOKEN用户在开放平台中获取的 Token，参考插件身份凭证章节。必须
X-USER-KEY当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取可选
X-IDEM-UUID写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断可选

参考请求格式如下：

curl --location -g --request GET '{base_url}/open_api/:project_key/template_list/:work_item_type_key' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

参数名是否必填值类型说明
project_key是string空间id [project_key]，或者空间域名 [simple_name]
work_item_type_key是string工作项类型，可以从获取工作项类型接口获取

请求参数

参数名是否必填值类型说明
work_item_type_key是string工作项类型，可查询指定工作项下的字段，推荐使用该方式获取

返回值类型

list[SimpleField]

返回格式 

{
    "data": [
        {
            "field_alias": "name",
            "field_key": "name",
            "field_name": "名称",
            "field_type_key": "text",
            "is_custom_field": false
        },
        {
            "field_alias": "description",
            "field_key": "description",
            "field_name": "描述",
            "field_type_key": "multi_text",
            "is_custom_field": false
        },
        {
            "field_alias": "owner",
            "field_key": "owner",
            "field_name": "创建者",
            "field_type_key": "user",
            "is_custom_field": false
        }
    ],
    "err": {},
    "err_msg": "",
    "err_code": 0
}