飞书项目帮助中心

Appearance

Return to top
页面导航

创建工作项

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/create
请求方式POST

请求 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/create' \
--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工作项类型，自定义工作项可通过获取空间下的工作项类型获取。
name是string工作项名称
field_value_pairs否list[FieldValuePair]创建工作项的具体字段可以从获取创建工作项元数据接口中获取，字段格式可查看字段格式对应表。
template_id是int64模板ID，可以从以下途径获取:
1. 获取创建工作项元数据接口中的template字段的options中获取，选择对应的value
2. 获取工作项下的流程类型接口的template_id
3. 获取空间字段接口中的template字段的options中获取，选择对应的value

请求体格式 

{
    
    "work_item_type_key": "story",
    "template_id": 123123,
    "name":"2333",
    "field_value_pairs": [
        {
            "field_key": "description",
            "field_value": "2333"
        },
        {
            "field_key":"priority",
            "field_value":{
                "label":"P0",
                "value":"0"
            }
        },
        {
            "field_key": "role_owners",
            "field_value":[
                {
                   "role":"rd",
                   "owners":["testuser"]//user_key列表
                }
            ]
        }
    ]
}

返回格式 

{
    "data": 19781, // id
    "err": {},
    "err_msg": "",
    "err_code": 0
}