飞书项目帮助中心

Appearance

Return to top
页面导航

获取创建工作项元数据

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/:work_item_type_key/meta
请求方式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/work_item/:work_item_type_key/meta' \
--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工作项类型，可以从获取工作项类型接口获取。

返回值类型

list[FieldConf]

返回格式 

{
     "data": [
        {
            "default_value": { 
                "default_appear": 3, //是否存在默认值，Appear = 1 //默认出现NoAppear = 2 //默认不出现CondAppear = 3 //条件出现
                "value": null //默认值
            },
            "field_alias": "name", //对接标识
            "field_key": "name", //字段key
            "field_name": "名称", //字段名称
            "field_type_key": "text", //字段类型
            "is_required": 2, //是否必填 Required = 1 //必填 NoRequired = 2 //非必填 CondRequired = 3 //条件必填
            "is_validity": 1, //有效性 True = 1 //有效 False = 2 //无效
            "is_visibility": 1, //可见性 Visibility = 1 //可见 CondVisibility = 2 //条件可见
            "label": "name" //表单项名称
        },
        {
            "default_value": {
                "default_appear": 1,
                "value": "123\n"
            },
            "field_alias": "description",
            "field_key": "description",
            "field_name": "描述",
            "field_type_key": "multi_text",
            "is_required": 2,
            "is_validity": 1,
            "is_visibility": 1,
            "label": ""
        },
        {
            "default_value": {
                "value": null
            },
            "field_alias": "",
            "field_key": "role_owners",
            "field_name": "角色与人员",
            "field_type_key": "role_owners",
            "is_required": 2,
            "is_validity": 1,
            "is_visibility": 1,
            "label": "",
            "role_assign": [
                {
                    "default_appear": 3,
                    "deletable": 1,
                    "member_assign": 3,
                    "name": "PM",
                    "role": "PM"
                },
                {
                    "default_appear": 1,
                    "deletable": 2,
                    "member_assign": 4,
                    "name": "需求评审委员会",
                    "role": "RD"
                },
             ]
         },
     ],
     "err": {},
     "err_code": 0,
     "err_msg": ""
}