获取工作项列表

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

identifier

string

工作项编号。

可选

project_ids

string

可选

项目的id，使用','分割，最多只能20个。

type_ids

string

可选

工作项类型的id，瀑布项目下工作项的类型id或者非瀑布下的工作项类型：epic， feature， story， task， bug和 issue，使用','分割，最多只能20个。

parent_ids

string

可选

父工作项的id，使用','分割，最多只能20个。

assignee_ids

string

可选

工作项负责人的id，使用','分割，最多只能20个。

state_ids

string

可选

工作项状态的id，使用','分割，最多只能20个。

start_between

number

可选

开始时间介于的时间范围，通过','分割起始时间。比如1580000000,1590000000表示开始时间介于两个时间之间；,1590000000表示开始时间小于该时间；1580000000表示开始时间大于该时间。

end_between

number

可选

结束时间介于的时间范围，通过','分割起始时间。使用方式参考开始时间。

priority_ids

string

可选

工作项优先级的id，使用','分割，最多只能20个。

bug_type_ids

string

可选

缺陷类别的id，使用','分割，最多只能20个。

sprint_ids

string

可选

迭代的id，使用','分割，最多只能20个。

board_ids

string

可选

看板的id，使用','分割，最多只能20个。

entry_ids

string

可选

看板栏的id，使用','分割，最多只能20个。

tag_ids

string

可选

工作项标签的id，使用','分割，最多只能20个。

swimlane_ids

string

可选

泳道的id，使用','分割，最多只能20个。

phase_ids

string

可选

所属计划的id，使用','分割，最多只能20个。

version_ids

string

可选

发布的id，使用','分割，最多只能20个。

created_by_ids

string

可选

创建人的id，使用','分割，最多只能20个。

created_between

string

可选

创建时间介于的时间范围，通过','分割起始时间。使用方式参考开始时间。

updated_between

string

可选

更新时间介于的时间范围，通过','分割起始时间。使用方式参考开始时间。

participant_id

string

可选

工作项关注人的id。

keywords

string

可选

关键字。支持工作项编号和工作项标题。

include_deleted

string

可选

是否查询已删除的工作项。该值默认为false。

include_archived

string

可选

是否查询已归档的工作项。该值默认为false。

返回响应

🟢200成功

application/json

Body

page_size

integer

必需

page_index

integer

必需

total

integer

必需

values

array [object {28}]

必需

string

必需

url

string

必需

project

object

必需

identifier

string

必需

title

string

必需

type

string

必需

start_at

integer

必需

end_at

integer

必需

assignee

object

必需

state

object

必需

priority

object

必需

description

string

必需

completed_at

integer

必需

properties

object

必需

tags

array [object {3}]

必需

participants

array [object {4}]

必需

created_at

integer

必需

created_by

object

必需

updated_at

integer

必需

updated_by

object

必需

is_archived

integer

必需

is_deleted

integer

必需

parent_id

string

必需

parent

object

必需

version

object

必需

sprint

object

可选

phase

object

可选

story_points

integer

可选

示例

{
    "page_size": 30,
    "page_index": 0,
    "total": 4,
    "values": [
        {
            "id": "5edca524cad2fa112b06305c",
            "url": "https://rest_api_root/v1/project/work_items/5edca524cad2fa112b06305c",
            "project": {
                "id": "5eb623f6a70571487ea47000",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000",
                "identifier": "SCR",
                "name": "Scrum项目",
                "type": "scrum"
            },
            "identifier": "SCR-1",
            "title": "这是一个史诗",
            "type": "epic",
            "start_at": 1583290309,
            "end_at": 1583290347,
            "assignee": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "state": {
                "id": "5c9b35de90ad7153c2062f18",
                "url": "https://rest_api_root/v1/project/states/5c9b35de90ad7153c2062f18",
                "name": "新建",
                "type": "pending",
                "color": "#ff7575"
            },
            "priority": {
                "id": "5eb623f6a70571487ea47111",
                "url": "https://rest_api_root/v1/project/priorities/5eb623f6a70571487ea47111",
                "name": "最高"
            },
            "description": "这是一个史诗的描述",
            "completed_at": 1583290347,
            "properties": {
                "prop_a": "prop_a_value",
                "prop_b": "prop_b_value",
                "risk": null,
                "business_value": null,
                "effort": 123,
                "backlog_from": null
            },
            "tags": [
                {
                    "id": "5e6b35de50ef8153c2062f70",
                    "url": "https://rest_api_root/v1/project/tags/5e6b35de50ef8153c2062f70",
                    "name": "标签-1"
                }
            ],
            "participants": [
                {
                    "id": "a0417f68e846aae315c85d24643678a9",
                    "url": "https://rest_api_root/v1/project/work_items/5edca524cad2fa112b06305c/participants/a0417f68e846aae315c85d24643678a9",
                    "type": "user",
                    "user": {
                        "id": "a0417f68e846aae315c85d24643678a9",
                        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                        "name": "john",
                        "display_name": "John",
                        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
                    }
                }
            ],
            "created_at": 1583290300,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "updated_at": 1583290300,
            "updated_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "is_archived": 0,
            "is_deleted": 0
        },
        {
            "id": "5edfa3b67463c1ee626c0979",
            "url": "https://rest_api_root/v1/project/work_items/5edfa3b67463c1ee626c0979",
            "project": {
                "id": "5eb623f6a70571487ea47000",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000",
                "identifier": "SCR",
                "name": "Scrum项目",
                "type": "scrum"
            },
            "identifier": "SCR-2",
            "title": "这是一个特性",
            "type": "feature",
            "start_at": 1583290309,
            "end_at": 1583290347,
            "parent_id": "5edca524cad2fa112b06305c",
            "parent": {
                "id": "5edca524cad2fa112b06305c",
                "url": "https://rest_api_root/v1/project/work_items/5edca524cad2fa112b06305c",
                "identifier": "SCR-1",
                "title": "这是一个史诗",
                "type": "epic",
                "start_at": 1583290309,
                "end_at": 1583290347
            },
            "assignee": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "version": {
                "id": "5eb623487ea47001f6a70571",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/versions/5eb623487ea47001f6a70571",
                "name": "1.0.1",
                "start_at": 1565255712,
                "end_at": 1565255879,
                "stage": {
                    "id": "5f44a8f8bb347b14b49624a1",
                    "url": "https://rest_api_root/v1/project/stages/5f44a8f8bb347b14b49624a1",
                    "name": "未开始",
                    "type": "pending",
                    "color": "#FA8888"
                }
            },
            "state": {
                "id": "5c9b35de90ad7153c2062f18",
                "url": "https://rest_api_root/v1/project/states/5c9b35de90ad7153c2062f18",
                "name": "新建",
                "type": "pending",
                "color": "#ff7575"
            },
            "priority": {
                "id": "5eb623f6a70571487ea47111",
                "url": "https://rest_api_root/v1/project/priorities/5eb623f6a70571487ea47111",
                "name": "最高"
            },
            "description": "这是一个特性的描述",
            "completed_at": 1583290347,
            "properties": {
                "prop_a": "prop_a_value",
                "prop_b": "prop_b_value",
                "risk": null,
                "business_value": null,
                "effort": null,
                "backlog_type": null,
                "backlog_from": null
            },
            "tags": [
                {
                    "id": "5e6b35de50ef8153c2062f70",
                    "url": "https://rest_api_root/v1/project/tags/5e6b35de50ef8153c2062f70",
                    "name": "标签-1"
                }
            ],
            "participants": [
                {
                    "id": "a0417f68e846aae315c85d24643678a9",
                    "url": "https://rest_api_root/v1/project/work_items/5edfa3b67463c1ee626c0979/participants/a0417f68e846aae315c85d24643678a9",
                    "user": {
                        "id": "a0417f68e846aae315c85d24643678a9",
                        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                        "name": "john",
                        "display_name": "John",
                        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
                    }
                }
            ],
            "created_at": 1583290300,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "updated_at": 1583290300,
            "updated_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "is_archived": 1,
            "is_deleted": 1
        },
        {
            "id": "5edca112b06305c524cad2fa",
            "url": "https://rest_api_root/v1/project/work_items/5edca112b06305c524cad2fa",
            "project": {
                "id": "5eb623f6a70571487ea47000",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000",
                "identifier": "SCR",
                "name": "Scrum项目",
                "type": "scrum"
            },
            "identifier": "SCR-3",
            "title": "这是一个用户故事",
            "type": "story",
            "start_at": 1583290309,
            "end_at": 1583290347,
            "parent_id": "5edfa3b67463c1ee626c0979",
            "parent": {
                "id": "5edfa3b67463c1ee626c0979",
                "url": "https://rest_api_root/v1/project/work_items/5edfa3b67463c1ee626c0979",
                "identifier": "SCR-2",
                "title": "这是一个特性",
                "type": "feature",
                "start_at": 1583290309,
                "end_at": 1583290347,
                "parent_id": "5edca524cad2fa112b06305g"
            },
            "assignee": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "version": {
                "id": "5eb623487ea47001f6a70571",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/versions/5eb623487ea47001f6a70571",
                "name": "1.0.1",
                "start_at": 1565255712,
                "end_at": 1565255879,
                "stage": {
                    "id": "5f44a8f8bb347b14b49624a1",
                    "url": "https://rest_api_root/v1/project/stages/5f44a8f8bb347b14b49624a1",
                    "name": "未开始",
                    "type": "pending",
                    "color": "#FA8888"
                }
            },
            "sprint": {
                "id": "5ecf7b74eaab845a2aa53138",
                "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/sprints/5ecf7b74eaab845a2aa53138",
                "name": "Sprint 1",
                "start_at": 1589791860,
                "end_at": 1589791860,
                "status": "completed"
            },
            "state": {
                "id": "5c9b35de90ad7153c2062f18",
                "url": "https://rest_api_root/v1/project/states/5c9b35de90ad7153c2062f18",
                "name": "新建",
                "type": "pending",
                "color": "#ff7575"
            },
            "priority": {
                "id": "5eb623f6a70571487ea47111",
                "url": "https://rest_api_root/v1/project/priorities/5eb623f6a70571487ea47111",
                "name": "最高"
            },
            "description": "这是一个用户故事的描述",
            "completed_at": 1583290347,
            "properties": {
                "prop_a": "prop_a_value",
                "prop_b": "prop_b_value",
                "risk": null,
                "backlog_type": null,
                "backlog_from": null
            },
            "tags": [
                {
                    "id": "5e6b35de50ef8153c2062f70",
                    "url": "https://rest_api_root/v1/project/tags/5e6b35de50ef8153c2062f70",
                    "name": "标签-1"
                }
            ],
            "participants": [
                {
                    "id": "a0417f68e846aae315c85d24643678a9",
                    "url": "https://rest_api_root/v1/project/work_items/5edca112b06305c524cad2fa/participants/a0417f68e846aae315c85d24643678a9",
                    "type": "user",
                    "user": {
                        "id": "a0417f68e846aae315c85d24643678a9",
                        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                        "name": "john",
                        "display_name": "John",
                        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
                    }
                }
            ],
            "created_at": 1583290300,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "updated_at": 1583290300,
            "updated_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "is_archived": 0,
            "is_deleted": 0
        },
        {
            "id": "5edca5d2fa112b06305c24ca",
            "url": "https://rest_api_root/v1/project/work_items/5edca5d2fa112b06305c24ca",
            "project": {
                "id": "6375cc81e3004de4ea14aa52",
                "url": "http://rest_api_root/v1/project/projects/6375cc81e3004de4ea14aa52",
                "identifier": "WTF",
                "name": "瀑布项目",
                "type": "waterfall"
            },
            "identifier": "WTF-2",
            "title": "这是一个瀑布项目下需求类型的工作项",
            "type": "630da48bc9443b1aa94ce3ea",
            "start_at": 1583290309,
            "end_at": 1583290347,
            "assignee": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "state": {
                "id": "5c9b35de90ad7153c2062f18",
                "url": "https://rest_api_root/v1/project/states/5c9b35de90ad7153c2062f18",
                "name": "新建",
                "type": "pending",
                "color": "#ff7575"
            },
            "priority": {
                "id": "5eb623f6a70571487ea47111",
                "url": "https://rest_api_root/v1/project/priorities/5eb623f6a70571487ea47111",
                "name": "最高"
            },
            "phase": {
                "id": "63761fee31caaf77189816b4",
                "url": "http://rest_api_root/v1/project/projects/63761fee31caaf7718981698/phases/63761fee31caaf77189816b4",
                "title": "这是一个阶段",
                "identifier": "WTF-1"
            },
            "description": "这是一个瀑布项目下需求类型的工作项描述",
            "completed_at": 1583290347,
            "story_points": 1,
            "properties": {
                "prop_a": "prop_a_value",
                "prop_b": "prop_b_value",
                "backlog_type": null,
                "backlog_from": null,
                "phase": null
            },
            "tags": [
                {
                    "id": "5e6b35de50ef8153c2062f70",
                    "url": "https://rest_api_root/v1/project/tags/5e6b35de50ef8153c2062f70",
                    "name": "标签-1"
                }
            ],
            "participants": [
                {
                    "id": "a0417f68e846aae315c85d24643678a9",
                    "url": "https://rest_api_root/v1/project/work_items/5edca112b06305c524cad2fa/participants/a0417f68e846aae315c85d24643678a9",
                    "type": "user",
                    "user": {
                        "id": "a0417f68e846aae315c85d24643678a9",
                        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                        "name": "john",
                        "display_name": "John",
                        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
                    }
                }
            ],
            "created_at": 1583290300,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "updated_at": 1583290300,
            "updated_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            },
            "is_archived": 0,
            "is_deleted": 0
        }
    ]
}

请求参数

示例代码

返回响应