查询工作项详情V2 - ShowIpdIssueDetailV2

codeartsreq:workitem:get

Read

-

• codeartsreq:Model

• codeartsreq:ProjectId

-

-

project_id

是

String

参数解释：

项目32位ID，项目唯一标识。通过查询IPD项目列表获取，响应消息体中的id字段的值就是项目ID。

约束限制：

不涉及。

取值范围：

32个字符，由英文字母和数字组成。

默认取值：

不涉及。

issue_id

是

String

参数解释：

工作项唯一ID。可以通过查询工作项列表或者查询树状工作项接口获取，响应消息体中的id字段的值就是工作项ID。

约束限制：

不涉及。

取值范围：

18~19个字符的数字字符串。

默认取值：

不涉及。

category

是

String

参数解释：

工作项类型。

约束限制：

不涉及

取值范围：

支持多种工作项类型，使用英文逗号分隔。

• 系统设备类项目：RR、SF、IR、SR、AR、Task、Bug

• 独立软件类项目：RR、SF、IR、US、Task、Bug

• 云服务类项目：RR、Epic、FE、US、Task、Bug

默认取值：

不涉及

status

String

参数解释：

返回状态。

取值范围：

success：响应成功。

error：响应失败

message

String

参数解释：

请求返回信息。

取值范围：

不涉及

data

IssueInfoVO object

参数解释：

工作项详情。

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

参数解释：

项目的32位UUID，项目唯一标识。

取值范围：

不涉及

status

String

参数解释：

工作项状态code。

取值范围：

Start：初始态。

Analyse：待分析。

Develop：开发中。

Test：测试中。

Finish：已完成。

state

String

参数解释：

工作项的生命周期。

取值范围：

• 正在工作：可正常操作的工作项

• 作废：软删除后的工作项，可在回收站恢复

assignee

UserEntity object

参数解释：

工作项责任人。

assigned_cc

Array of UserEntity objects

参数解释：

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

created_by

UserEntity object

参数解释：

工作项创建人。

created_time

String

参数解释：

工作项创建时间，unix时间戳，单位：毫秒。

取值范围：

不涉及。

modified_by

UserEntity object

参数解释：

工作项最近更新人。

modified_time

String

参数解释：

工作项最近更新时间，unix时间戳，单位：毫秒。

取值范围：

不涉及。

plan_end_date

String

参数解释：

工作项计划结束日期，unix时间戳，单位：毫秒。

取值范围：

不涉及。

close_time

String

参数解释：

工作项关闭时间，unix时间戳，单位：毫秒。

取值范围：

不涉及。

workload

String

参数解释：

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

取值范围：

0~999999999.9。

workload_sum

String

参数解释：

工作项实际工时。

取值范围：

0~999999999.9。

tenant_id

String

参数解释：

工作项所属租户ID，可通过查询树状工作项接口获取，响应消息体中的tenant_id字段的值就是工作项所属租户ID。

取值范围：

不涉及。

link

String

参数解释：

工作项关联项ID。

取值范围：

不涉及。

suspended

Boolean

参数解释：

工作项是否已挂起。

取值范围：

true，false。

status_modified_time

String

参数解释：

工作项状态改变时间，可用于计算工作项在当前状态停留天数，unix时间戳，单位：毫秒。

取值范围：

不涉及。

labels

Array of LabelEntity objects

参数解释：

工作项标签。

custom_fields

Array of FieldCodeValuePair objects

参数解释：

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

{

"code":"字段code",

"value":"字段值"

}。

children

Array of IssueInfoVO objects

参数解释：

工作项的子工作项集合。

path

String

参数解释：

子工作项的路径。

取值范围：

不涉及。

ir2feature

String

参数解释：

IR和SF的关联字段。

need_break

String

参数解释：

工作项是否需要分解。

取值范围：

• yes：需要分解

• no：不需要分解

break_status

String

参数解释：

分解状态。

已分解（decomposed）

未分解（undecomposed）

不涉及（ --）。

取值范围：

decomposed，undecomposed，--。

baseline

String

参数解释：

工作项基线状态。

取值范围：

• null：未基线

• baselined：已基线

• baseline-reviewing：基线评审中

priority

String

参数解释：

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

取值范围：

• 低：低优先级。

• 中：中优先级。

• 高：高优先级。

related_network_security

String

参数解释：

是否涉及网络安全。

取值范围：

• yes：涉及网络安全。

• no：不涉及网络安全。

collaboratives

String

参数解释：

研发需求协同信息，协同任务ID，可通过查询树状工作项接口获取，响应消息体中的collaboratives字段的值就是研发需求协同信息，协同任务ID。

取值范围：

不涉及。

business_domain

String

参数解释：

领域字段。

取值范围：

• software

• soft-hardware

• hardware

• 性能

• 功能

• 运维

• 运营

• 用户体验

• 隐私保护

• 合规

• 韧性(可靠性/可用性)

• 韧性(危险检测与相应恢复)

• 透明

• 无害

• 安全

• API

• 成本

• 可维护性

• 其他DFX

• 可用性

• others

plan_pi

String

参数解释：

工作项发布计ID。

取值范围：

不涉及。

plan_iteration

String

参数解释：

工作项完成的迭代计划ID，在Bug中为修复迭代计划ID。

取值范围：

不涉及。

change_status

String

参数解释：

工作项变更状态。

变更评审中（change-reviewing）

已变更（changed）

未变更（unchange或null）。

取值范围：

change-reviewing，changed，unchange，null。

no_break_reason

String

参数解释：

无需分解原因。

取值范围：

0~512个字符。

submitted_by

Array of UserEntity objects

参数解释：

工作项提出人。

ir2rr

String

参数解释：

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

取值范围：

不涉及。

feature_set

String

参数解释：

特性集ID。

取值范围：

不涉及。

expected_repair_date

String

参数解释：

期望修复时间。预设字段中，仅Bug有此字段，unix时间戳，单位：毫秒。

取值范围：

不涉及。

found_pi

String

参数解释：

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

取值范围：

不涉及。

found_iteration

String

参数解释：

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

取值范围：

不涉及。

reason_analysis

String

参数解释：

分析原因。

取值范围：

0~50000个字符。

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有此字段，可选值为problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。分别对应问题解决关闭，问题转需求关闭，重复问题关闭，非问题关闭。

取值范围：

problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。

id

String

参数解释：

用户ID，可通过查询项目成员列表接口获取，响应消息体中的id字段的值就是用户ID。

取值范围：

不涉及。

name

String

参数解释：

用户名称。

取值范围：

2~64个字符。

nick_name

String

参数解释：

用户昵称。

取值范围：

2~30个字符。

id

String

参数解释：

标签ID，可通过查询标签列表接口获取，响应消息体中的id字段的值就是标签ID。

取值范围：

18~19个字符的数字字符串。

category_types

Array of strings

参数解释：

标签所属工作项类型编码。

label_type

String

参数解释：

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

取值范围：

• raw requirement：原始需求

• feature：系统特性

• requirement：研发需求

• task：任务

• bug：缺陷

color

String

参数解释：

标签颜色RGB。

取值范围：

可选颜色代码与对应中文描述如下：

• #86CAFF：浅蓝色

• #6DDEBB：青绿色

• #A6DD82：黄绿色

• #FAC20A：金黄色

• #FA9841：橙色

• #F66F6A：珊瑚红

• #F3689A：粉红色

• #A97AF8：淡紫色

• #71757F：中性灰

• #5E7CE0：宝蓝色

• #207AB3：深蓝色

• #169E6C：翠绿色

• #6CA83B：草绿色

• #B58200：棕黄色

• #B54E04：赭石色

• #B02121：朱红色

• #AD215B：玫红色

• #572DB3：深紫色

• #4F4F4F：深灰色

• #3C51A6：靛蓝色

title

String

参数解释：

标签标题。

取值范围：

不涉及。

code

String

参数解释：

工作项自定义字段code值。可选值可以通过查询字段模板列表接口获取，响应体中的code就是字段唯一标识。

取值范围：

不涉及。

value

String

参数解释：

工作项自定义字段值。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述，对error_code的补充解释。

取值范围：

不涉及。

200

OK

400

请求失败的响应。例如无操作权限、项目不存在。