飞书项目帮助中心

Appearance

Return to top
页面导航

获取空间下工作项类型

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/all-types
请求方式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/projects' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

参数名是否必填值类型说明
project_keys否string空间id [project_key]，或者空间域名 [simple_name]

返回值类型 

list<WorkItemKeyType>

返回格式 

{
    "data":[
        {
            "type_key":"story",//工作项类型
            "name":"需求"//工作项名称
        }, 
        {
            "type_key":"issue",
            "name":"缺陷"
        }
    ],
    "err": {},
    "err_msg": "",
    "err_code": 0
}