飞书项目帮助中心

Appearance

Return to top
页面导航

获取指定的关联工作项列表

一：单空间

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id/search_by_relation
请求方式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/:work_item_id/search_by_relation' \
--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_id是string工作项ID

请求体格式 

{
    "relation_work_item_type_key": "issue",
    "relation_key":"_field_linked_story",
    "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"
                    ]
                }
            ],
            "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
    }
}