获取指定的工作项列表

一：非跨空间

请求体说明

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

字段	值	必须填写
Content-Type	application/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/filter' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

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

请求参数

参数名	是否必填	值类型	说明
work_item_name	是	string	工作项名称，支持模糊搜索。
user_keys	否	list[string]	用户信息列表，支持搜索创建人/关注人/角色人员为该用户的相关工作项。
work_item_type_keys	否	list[string]	工作项类型列表
work_item_ids	是	list[int64]	工作项ID列表
created_at	否	TimeInterval	创建时间，支持时间区间查询，可不传截止时间，代表至今。
updated_at	否	TimeInterval	更新时间，支持时间区间查询，可不传截止时间，代表至今。
sub_stages	否	list[string]	需求工作项状态列表
work_item_status	否	list[WorkItemStatus]	工作项状态列表
businesses	否	list[string]	业务线列表
priorities	否	list[string]	优先级列表
tags	否	list[string]	标签列表
page_size	否	int64	每页数据，最大 200
page_num	否	int64	分页页码，从 1 开始，默认为 1

请求体格式

{
    "work_item_type_keys": [
        "story"
    ],
    "page_size":159
}

返回值类型

list[WorkItemInfo]

返回格式

{
    "data":[//结构同获取工作项详情
        {
            "id":1,
            "name":"item1",
            "work_item_type_key":"story",
            "project_key":"60acd5610444ba031b503055",
            "simple_name":"test",
            "template_type":"control",
            "pattern":"Node",
            "sub_stage":"started",
            "work_item_status": {},
            "current_node":[
                {
                    "id":"state_1",
                    "name":"node1",
                    "owners":[
                        "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",
            "updated_by":"7009146719661228031",
            "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,
    "pagination": {
        "page_num": 1,
        "page_size": 10,
        "total": 1
    }
}

二：跨空间

请求体说明

类别	值
请求地址	{base_url}/open_api/work_items/filter_across_project
请求方式	POST

请求 Header

字段	值	必须填写
Content-Type	application/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/work_items/filter_across_project' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

请求参数

参数名	是否必填	值类型	说明
project_keys	否	list[string]	空间id(project_key)列表;传了空间id，会取空间id与插件安装的空间的交集。未传空间id，会取header中用户有权限的空间与插件安装的空间的交集。
simple_names	否	list[string]	空间域名(simple_name)列表
work_item_name	是	string	工作项名称，支持模糊搜索。
search_user	否	SearchUser	用户信息列表，支持搜索指定人员为该用户的相关工作项。
work_item_type_keys	否	list[string]	工作项类型列表，可以从获取工作项类型接口获取。
work_item_ids	是	list[int64]	工作项ID列表，最多传入50个。
created_at	否	TimeInterval	创建时间，支持时间区间查询，可不传截止时间，代表至今。
updated_at	否	TimeInterval	更新时间，支持时间区间查询，可不传截止时间，代表至今。
sub_stages	否	list[string]	需求工作项状态列表
work_item_status	否	list[WorkItemStatus]	工作项状态列表
businesses	否	list[string]	业务线列表
priorities	否	list[string]	优先级列表
tags	否	list[string]	标签列表
page_size	否	int64	每页数据，最大 50
page_num	否	int64	分页页码，从 1 开始，默认为 1
tenant_group_id	渠道用户必填	int64	渠道 id

请求体格式

{
    "work_item_type_key": "story",
    "search_user":{
         "field_key":"owner",
         "user_keys":["test_user"]
    },
    "page_size":159
}

返回值类型

list[WorkItemInfo]，最多只能查询到 2000 条数据，超过请自行用过滤条件减少匹配的工作项数目。

返回格式

{
    "data":[//结构同获取工作项详情
        {
            "id":1,
            "name":"item1",
            "work_item_type_key":"story",
            "project_key":"60acd5610444ba031b503055",
            "simple_name":"test",
            "template_type":"control",
            "pattern":"Node",
            "sub_stage":"started",
            "work_item_status": {},
            "current_node":[
                {
                    "id":"state_1",
                    "name":"node1",
                    "owners":[
                        "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",
            "updated_by":"7009146719661228031",
            "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,
    "pagination": {
        "page_num": 1,
        "page_size": 10,
        "total": 1
    }
}

获取指定的工作项列表 #

一：非跨空间 #

请求体说明 #

请求 Header #

路径参数 #

请求参数 #

请求体格式 #

返回值类型 #

返回格式 #

二：跨空间 #

请求体说明 #

请求 Header #

请求参数 #

请求体格式 #

返回值类型 #

返回格式 #

获取指定的工作项列表

一：非跨空间

请求体说明

请求 Header

路径参数

请求参数

请求体格式

返回值类型

返回格式

二：跨空间

请求体说明

请求 Header

请求参数

请求体格式

返回值类型

返回格式