文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工作项管理/ 查询工作项详情
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

查询工作项详情

功能介绍

查询工作项详情，只返回工作项基本信息，不返回关联项和子工作项

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/ipdprojectservice/projects/{project_id}/issues/{issue_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目Id

issue_id

是

String

工作项Id
表2 Query参数

参数

是否必选

参数类型

描述

category

是

String

工作项类型，系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态

message

String

请求失败信息

data

IssueEntity object

工作项详情
表4 IssueEntity

参数

参数类型

描述

id

String

工作项id

title

String

工作项标题

description

String

工作项描述字段

type

String

工作项大分类定义

requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求)

number

String

工作项编号

category

String

工作项类型，系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。

编辑工作项时，此字段必填、值为当前工作项正确的工作项类型，但不会更新此字段

parent_id

String

父工作项id

project_id

String

工作项所属的项目id

status

String

工作项状态code

state

String

工作项的生命周期，可选值为"正在工作","作废"

assignee

UserEntity object

工作项责任人

assigned_cc

Array of UserEntity objects

工作项抄送人，支持多个抄送人。同一工作项最多支持50个抄送人

created_by

UserEntity object

工作项创建人

created_time

String

工作项创建时间

modified_by

UserEntity object

工作项最近更新人

modified_time

String

工作项最近更新时间

plan_end_date

String

工作项计划结束日期，时间戳

close_time

String

工作项关闭时间

workload

String

工作项计划工时，保留一位小数，取值范围为0~999999999.9

workload_sum

String

工作项计划工时，保留一位小数，取值范围为0~999999999.9，不可编辑

tenant_id

String

工作项所属租户id

link

String

工作项关联项id，多个关联项用英文逗号分隔，同一工作项最多支持50个关联项

suspended

Boolean

工作项是否已挂起

status_modified_time

String

工作项状态改变时间，可用于计算工作项在当前状态停留天数

labels

Array of LabelEntity objects

工作项标签

custom_fields

Array of FieldCodeValuePair objects

工作项自定义字段映射，用户添加的系统字段也在此列

{

"code":"字段code",

"value":"字段值"

}

children

Array of IssueEntity objects

工作项的子工作项集合

path

String

子工作项的路径

ir2feature

String

IR和FE的关联字段，工作项类型为IR时，有此字段

need_break

String

工作项是否需要分解,仅可以分解的工作项类型有此字段

break_status

String

分解状态

已分解—decomposed

未分解—undecomposed

不涉及— --

baseline

String

工作项基线状态

未基线 —— null

已基线 —— baselined

基线评审中——baseline-reviewing

priority

String

工作项优先级，部分工作项有此字段

related_network_security

String

是否涉及网络安全。预设字段中，仅研发需求有此字段

collaboratives

String

研发需求协同信息，协同任务id

business_domain

String

领域字段

plan_pi

String

工作项发布(老版本名为PI) id

plan_iteration

String

工作项完成的迭代，在Bug中为修复迭代

change_status

String

工作项变更状态

变更评审中——change-reviewing

已变更——changed

未变更-unchange或null

no_break_reason

String

无需分解原因，need_break=no时有此字段

submitted_by

Array of UserEntity objects

工作项提出人

ir2rr

String

IR关联的RR id，多选时用英文逗号分隔

feature_set

String

特性集id

expected_repair_date

String

期望修复时间。预设字段中，仅Bug有此字段

found_pi

String

缺陷发现发布。预设字段中，仅Bug有此字段

found_iteration

String

缺陷发现迭代。预设字段中，仅Bug有此字段

reason_analysis

String

分析原因。预设字段中，仅Bug有此字段

repair_solution

String

修复方案。预设字段中，仅Bug有此字段

test_report

String

测试报告。预设字段中，仅Bug有此字段

sys_no_repair_reason

String

无需修复原因。预设字段中，仅Bug有此字段

sys_activation_reason

String

激活原因。预设字段中，仅Bug有此字段

sys_return_reason

String

退回原因。预设字段中，仅Bug有此字段

test_failures_times

Integer

回归不通过次数。预设字段中，仅Bug有此字段

close_type

String

关闭类型。预设字段中，仅Bug有此字段;可选值为 问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭
表5 UserEntity

参数

参数类型

描述

id

String

用户Id

name

String

用户名称

nick_name

String

用户昵称
表6 LabelEntity

参数

参数类型

描述

id

String

标签id

label_type

String

标签所属工作项类型，对应工作项的type字段

color

String

标签颜色RGB

title

String

标签标题
表7 FieldCodeValuePair

参数

参数类型

描述

code

String

工作项字段code值

value

String

工作项自定义字段值，为多选时用英文逗号分隔

请求示例

查询研发需求详情

{endpoint}/v2/ipdprojectservice/projects/ce075137bdb74086a700ce80dfd5f08a/issues/1027299517722046465?category=IR

响应示例

状态码： 200

OK

{
  "status" : "success",
  "message" : null,
  "data" : {
    "id" : "1027299517722046465",
    "title" : "11111",
    "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>",
    "type" : "requirement",
    "number" : "IR20240805197935",
    "category" : "IR",
    "project_id" : "ce075137bdb74086a700ce80dfd5f08a",
    "status" : "Start",
    "state" : "正在工作",
    "assignee" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试昵称"
    },
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试昵称"
    },
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试昵称"
    },
    "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
    "link" : "",
    "labels" : [ ],
    "custom_fields" : [ ],
    "path" : "/1027299517722046465",
    "ir2feature" : "",
    "need_break" : "yes",
    "break_status" : "decomposed",
    "priority" : "中",
    "related_network_security" : "no",
    "business_domain" : "software",
    "submitted_by" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_s00404480_01",
      "nick_name" : "测试昵称"
    } ],
    "ir2rr" : "1027242599229992961"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： IPD工作项管理

相关文档