飞书项目帮助中心

Appearance

Return to top
页面导航

获取工作项详情

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/:work_item_type_key/query
请求方式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/:work_item_type_key/query' \
--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_ids是list[int64]工作项ID 列表，一次请求最大 50 个。
fields否string定义需要返回的字段，非必填，默认返回全部，如果fields以-开头，表示返回除-号后字段中的所有字段，否则只返回 fields 中的字段，两种方式不能混用。如：
["aborted","role_owners"]表示只返回aborted和role_owners字段，
["-aborted","-role_owners"]表示返回除aborted和role_owners外的所有字段
expand否Expand额外参数：need_workflow：是否需要工作流信息（目前只支持节点流）

请求体格式 

{
    "work_item_ids":[12345,12323]
}

返回值类型

list[WorkItemInfo]

返回格式 

{
    "data":[
        {
            "id":1,//工作项id
            "name":"item1",//工作项名称
            "work_item_type_key":"story",//工作项类型
            "project_key":"60acd5610444ba031b503055",//空间id
            "simple_name":"test",//空间域名
            "template_id":12345//使用的模板id
            "template_type":"control",//模板类型
            "pattern":"Node",//工作流模式;Node节点流，State状态流
            "sub_stage":"started",//需求状态(仅需求有值)
            "work_item_status": {},//工作项状态(除需求外有值)
            "current_nodes":[//当前进行中节点(仅节点流有值)
                {
                    "id":"state_1",//节点id
                    "name":"node1",//节点名称
                    "owners":[//节点负责人userKey列表
                        "7012514555133820947"
                    ]
                }
            ],
            "state_times": [ //节点时间
                {
                    "end_time": 1654156400805,
                    "name": "开始",
                    "start_time": 1654156400804,
                    "state_key": "started"
                },
                {
                    "end_time": 0,
                    "name": "节点表单",
                    "start_time": 1654156400805,
                    "state_key": "doing"
                }
            ],
            "created_by":"7009146719661228031",//创建者userKey
            "updated_by":"7009146719661228031",//更新者userKey
            "created_at":1633776613033,//创建时间 毫秒时间戳
            "updated_at":1633776613033,//更新时间 毫秒时间戳
            "fields":[//工作项字段，字段格式可查看字段格式对应表
                {
                    "field_alias": "",
                    "field_key": "aborted",
                    "field_type_key": "aborted",
                    "field_value": {
                        "is_aborted": false,
                        "reason": ""
                    }
                },
                {
                    "field_alias": "",
                    "field_key": "role_owners",
                    "field_type_key": "role_owners",
                    "field_value": [
                        {
                            "owners": [
                                "7012514555184152596"
                            ],
                            "role": "uiouiouio"
                        },
                        {
                            "owners": null,
                            "role": "test"
                        },
                        {
                            "owners": null,
                            "role": "tt"
                        }
                    ]
                }
            ],
        }
    ],
    "err": {},
    "err_msg": "",
    "err_code": 0
}