查询工作项详情
功能介绍
查询工作项详情
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/issues/{issue_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目的32位uuid，项目唯一标识，可以通过ListProjectsV4接口查询项目列表 约束限制：正则表达式， ^[A-Za-z0-9]{32}$ 取值范围：字符串，最小长度：32，最大长度：32 默认取值：不涉及 |
|
issue_id |
是 |
Integer |
参数解释：工作项id，可通过ListIssuesV4接口高级查询工作项 约束限制：正则表达式，[0-9]{1,10}$ 取值范围：最小长度：1，最大长度：10 默认取值：不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制：不涉及 取值范围：最小长度：10，最大长度：32768 默认取值：不涉及 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
actual_work_hours |
Double |
实际工时，实际工时由详细工时自动累加和子工作项自动卷积计算 |
|
assigned_cc_user |
Array of IssueUser objects |
抄送人信息 |
|
assigned_user |
IssueUser object |
处理人信息 |
|
begin_time |
String |
预计开始时间，年-月-日 |
|
created_time |
String |
创建时间 年-月-日 时:分:秒 |
|
creator |
IssueUser object |
创建人信息 |
|
custom_fields |
Array of CustomField objects |
自定义字段,不建议使用，建议参考new_custom_fields字段 |
|
new_custom_fields |
Array of IssueDetailCustomField objects |
自定义字段信息 |
|
developer |
IssueUser object |
开发人员信息 |
|
domain |
domain object |
id, 领域 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' |
|
done_ratio |
Integer |
工作项完成度 |
|
end_time |
String |
预计结束时间，年-月-日 |
|
expected_work_hours |
Double |
预计工时 |
|
id |
Integer |
工作项id |
|
project |
IssueProjectResponseV4 object |
项目信息 |
|
iteration |
iteration object |
迭代 |
|
story_point |
story_point object |
故事点 |
|
module |
module object |
模块 |
|
name |
String |
标题 |
|
parent_issue |
parent_issue object |
父工作项 |
|
priority |
priority object |
工作项优先级 |
|
severity |
severity object |
工作项重要程度， 13 '提示'， 12 '一般'， 11 '重要'， 10 '关键' |
|
status |
status object |
工作项状态 |
|
release_dev |
String |
工作项发布版本号 |
|
find_release_dev |
String |
缺陷发现版本号（仅Bug类型工作项具备该字段） |
|
env |
env object |
缺陷发现环境（仅Bug类型工作项具备该字段） |
|
tracker |
tracker object |
工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
|
updated_time |
String |
更新时间 年-月-日 时:分:秒 |
|
closed_time |
String |
关闭时间 年-月-日 时:分:秒 |
|
description |
String |
工作项描述 |
|
order |
IssueOrder object |
用户信息 |
|
accessories |
Array of IssueAccessory objects |
附近列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
用户uuid |
|
user_num_id |
Integer |
用户数字id |
|
id |
Integer |
用户id |
|
name |
String |
用户名 |
|
nick_name |
String |
昵称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
custom_field |
String |
自定义字段 |
|
field_name |
String |
自定义字段名称 |
|
value |
String |
自定义属性对应的值，多个值以英文逗号区分开 |
|
field_type |
String |
自定义字段类型， textArea 多行文本，text 单行文本，select 下拉框，number 数字，time_date 日期，checkbox 多选框，radio 单选框 |
|
description |
String |
自定义字段描述 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
项目id |
|
project_name |
String |
项目名称 |
|
project_num_id |
Integer |
项目数字id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attachment_id |
Integer |
附件id |
|
issue_id |
Integer |
工作鞋ID |
|
creator_num_id |
Integer |
创建者数字ID |
|
created_date |
String |
附件创建时间 |
|
file_name |
String |
上传时文件名 |
|
container_type |
String |
附件id |
|
disk_file_name |
String |
附件名称 |
|
digest |
String |
附件id |
|
disk_directory |
String |
附件路径 |
|
creator_id |
String |
创建这用户uuid |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/4568921
响应示例
状态码： 200
OK
{
"actual_work_hours" : 0,
"assigned_cc_user" : [ {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "bear1"
} ],
"assigned_user" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "bear1"
},
"begin_time" : "2020-09-12",
"created_time" : "2020-09-13 14:40:11",
"creator" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "bear1"
},
"custom_fields" : [ {
"name" : "customField16",
"value" : "value",
"new_name" : "custom_field16"
} ],
"new_custom_fields" : [ {
"custom_field" : "custom_field16",
"field_name" : "bear1",
"value" : "bear11,bear12",
"field_type" : "textArea",
"description" : "description"
} ],
"developer" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "bear1"
},
"domain" : {
"id" : 14,
"name" : "性能"
},
"done_ratio" : 0,
"end_time" : "2020-09-19",
"expected_work_hours" : 9,
"id" : 4567,
"project" : {
"project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
"project_name" : "testDemo",
"project_num_id" : 78953
},
"iteration" : {
"id" : 456,
"name" : "iteeration1"
},
"story_point" : {
"id" : 3,
"name" : "1"
},
"module" : {
"id" : 456,
"name" : "Project"
},
"name" : "issueDemo",
"parent_issue" : {
"id" : 123,
"name" : "parentDemo"
},
"priority" : {
"id" : 1,
"name" : "低"
},
"severity" : {
"id" : 12,
"name" : "一般"
},
"status" : {
"id" : 1,
"name" : "新建"
},
"release_dev" : "0727",
"find_release_dev" : "0728",
"env" : {
"id" : 36,
"name" : "测试环境"
},
"tracker" : {
"id" : 7,
"name" : "story"
},
"updated_time" : "2020-09-14 14:40:11",
"closed_time" : "2020-09-15 14:40:11",
"description" : "demo",
"order" : {
"id" : 1,
"name" : "1"
},
"accessories" : [ {
"attachment_id" : 123444,
"issue_id" : 123444,
"creator_num_id" : 123444,
"created_date" : "2021-12-15 15:57:16",
"file_name" : "res.jpg",
"container_type" : "issue",
"disk_file_name" : "f0ef7216-fd05-40d4-8dea-6e6057739bb7.jpg",
"digest" : 123444,
"disk_directory" : 123444,
"creator_id" : "a360371833bf4c558f796fd707b44daf"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
