更新时间:2025-08-11 GMT+08:00
分享

查询事务详情V2

功能介绍

查询事务详情V2。

调用方法

请参见如何调用API

URI

GET /v2/issues/show

表1 Query参数

参数

是否必选

参数类型

描述

issue_id

Integer

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

project_uuid

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

include

String

参数解释:

查询包含的工作项父子类型。

约束限制:

不涉及。

取值范围:

children,parent。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回信息。

status

String

参数解释:

返回状态。

表4 result

参数

参数类型

描述

issue

IssueDetailResponseV2 object

参数解释:

自定义状态名称是否重复。

取值范围:

true(重复)

false(不重复)

表5 IssueDetailResponseV2

参数

参数类型

描述

actual_work_hours

Double

参数解释:

工作项的实际工时(单位:人/时)。

取值范围:

不涉及。

assigned_cc_user

Array of UserVO objects

参数解释:

当前工作项的抄送人。

assigned_to

UserVO object

参数解释:

工作项的当前责任人。

start_date

String

参数解释:

工作项的预计开始时间,时间戳格式(示例:1754323200000)。

取值范围:

不涉及。

created_on

String

参数解释:

工作项创建时间,时间戳格式(示例:1754374102000)。

取值范围:

不涉及。

author

UserVO object

参数解释:

工作项的创建人。

custom_fields

Array of CustomFieldV2 objects

参数解释:

工作项的自定义字段。

custom_value_new

IssueDetailCustomFieldV2 object

参数解释:

工作项的自定义字段。

developer

UserVO object

参数解释:

工作项的开发人员。

domain

domain object

参数解释:

工作项的领域信息。

done_ratio

Integer

参数解释:

工作项完成度。

取值范围:

不涉及。

end_time

String

参数解释:

工作项的预计结束时间,时间戳格式(示例:1754323200000)。

取值范围:

不涉及。

expected_work_hours

Double

参数解释:

工作项的预计完成工时(单位:人/时)。

取值范围:

不涉及。

id

Integer

参数解释:

工作项id。

取值范围:

不涉及。

project

ProjectVO object

参数解释:

工作项所属项目信息。

取值范围:

不涉及。

iteration

iteration object

参数解释:

工作项所属迭代信息。

story_point

story_point object

参数解释:

工作项的故事点信息。

module

module object

参数解释:

工作项的模块信息。

subject

String

参数解释:

工作项的标题。

取值范围:

不涉及。

parent_issue

parent_issue object

参数解释:

工作项的父工作项信息。

priority

priority object

参数解释:

工作项的优先级。

severity

severity object

参数解释:

工作项的重要程度。

status

status object

参数解释:

工作项的当前状态。

release_dev

String

参数解释:

工作项发布版本号。

取值范围:

不涉及。

find_release_dev

String

参数解释:

缺陷发现版本号(仅Bug类型工作项具备该字段)。

取值范围:

不涉及。

env

env object

参数解释:

缺陷发现环境(仅Bug类型工作项具备该字段)。

tracker

tracker object

参数解释:

工作项类型。

updated_on

String

参数解释:

工作项的最后更新时间,时间戳格式(示例:1754374102000)。

取值范围:

不涉及。

closed_time

String

参数解释:

工作项的关闭时间,时间戳格式(示例:1754374102000)。

取值范围:

不涉及。

description

String

参数解释:

工作项描述。

取值范围:

不涉及。

accessories_list

Array of IssueAccessoryV2 objects

参数解释:

工作项的附件列表。

inner_text

String

参数解释:

工作项更新的评论内容。

取值范围:

不涉及。

表6 UserVO

参数

参数类型

描述

assigned_nick_name

String

参数解释:

用户的昵称。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

id

Integer

参数解释:

用户的数字id。

取值范围:

不涉及。

identifier

String

参数解释:

用户的32位uuid。

取值范围:

不涉及。

last_name

String

参数解释:

用户姓名。

取值范围:

不涉及。

name

String

参数解释:

有租户信息的用户名。

取值范围:

不涉及。

表7 CustomFieldV2

参数

参数类型

描述

name

String

参数解释:

自定义字段。

取值范围:

不涉及。

value

String

参数解释:

自定义字段对应的值。

取值范围:

不涉及。

new_name

String

参数解释:

自定义字段修改后的名称。

取值范围:

不涉及。

表8 IssueDetailCustomFieldV2

参数

参数类型

描述

custom_field

String

参数解释:

自定义字段。

取值范围:

不涉及。

field_name

String

参数解释:

自定义字段名称。

取值范围:

不涉及。

value

String

参数解释:

自定义属性对应的值,多个值以英文逗号区分开。

取值范围:

不涉及。

field_type

String

参数解释:

自定义字段类型。

取值范围:

textArea 多行文本

text 单行文本

select 下拉框

number 数字

time_date 日期

checkbox 多选框

radio 单选框。

description

String

参数解释:

自定义字段描述。

取值范围:

不涉及。

表9 domain

参数

参数类型

描述

id

Integer

参数解释:

领域id。

取值范围:

不涉及。

name

String

参数解释:

领域名称。

取值范围:

不涉及。

表10 ProjectVO

参数

参数类型

描述

identifier

String

参数解释:

项目uuid

取值范围:

不涉及。

name

String

参数解释:

项目名称

取值范围:

不涉及。

id

Integer

参数解释:

项目数字id

取值范围:

不涉及。

project_type

String

参数解释:

项目类型

取值范围:

scrum。

表11 iteration

参数

参数类型

描述

id

Integer

参数解释:

工作项的迭代id。

取值范围:

不涉及。

name

String

参数解释:

工作项的迭代名称。

取值范围:

不涉及。

表12 story_point

参数

参数类型

描述

id

Integer

参数解释:

工作项的故事点id。

取值范围:

不涉及。

name

String

参数解释:

工作项的故事点名称。

取值范围:

不涉及。

表13 module

参数

参数类型

描述

id

Integer

参数解释:

工作项的模块id。

取值范围:

不涉及。

name

String

参数解释:

工作项的模块名称。

取值范围:

不涉及。

表14 parent_issue

参数

参数类型

描述

id

Integer

参数解释:

工作项的父工作项id。

取值范围:

不涉及。

name

String

参数解释:

工作项的父工作项名称。

取值范围:

不涉及。

表15 priority

参数

参数类型

描述

id

Integer

参数解释:

工作项的优先级id。

取值范围:

不涉及。

name

String

参数解释:

工作项的优先级名称。

取值范围:

高,中,低。

表16 severity

参数

参数类型

描述

id

Integer

参数解释:

工作项的重要程度id。

取值范围:

不涉及。

name

String

参数解释:

工作项的重要程度名称。

取值范围:

不涉及。

表17 status

参数

参数类型

描述

id

Integer

参数解释:

工作项的当前状态id。

取值范围:

不涉及。

name

String

参数解释:

工作项的当前状态名称。

取值范围:

不涉及。

表18 env

参数

参数类型

描述

id

Integer

参数解释:

缺陷发现环境id。

取值范围:

不涉及。

name

String

参数解释:

缺陷发现环境名称。

取值范围:

不涉及。

表19 tracker

参数

参数类型

描述

id

Integer

参数解释:

工作项的类型id。

取值范围:

2,3,5,6,7。

name

String

参数解释:

工作项的类型名称。

取值范围:

2:任务/Task

3:缺陷/Bug

5:Epic

6:Feature

7:Story。

表20 IssueAccessoryV2

参数

参数类型

描述

attachment_id

Integer

参数解释:

附件id。

取值范围:

不涉及。

issue_id

Integer

参数解释:

工作项数字id。

取值范围:

不涉及。

creator_num_id

Integer

参数解释:

附件的上传者数字ID。

取值范围:

不涉及。

created_date

String

参数解释:

附件创建时间(示例:2025-08-04 19:43:46)。

取值范围:

不涉及。

file_name

String

参数解释:

附件名称。

取值范围:

不涉及。

container_type

String

参数解释:

附件所属类型。

取值范围:

scrum。

disk_file_name

String

参数解释:

附件在服务器上实际名称。

取值范围:

不涉及。

digest

String

参数解释:

附件来源。

取值范围:

1:工作项本地上传的文档;2:关联的文档。

disk_directory

String

参数解释:

附件在服务器上的路径。

取值范围:

不涉及。

creator_id

String

参数解释:

附件的上传者uuid。

取值范围:

不涉及。

请求示例

GET https://{engdpoint}/v2/issues/show?project_uuId=d00fd603ddf64115939e7d3609d6cb05&issue_id=69792725&include=children,parent&_=1753156521643

响应示例

状态码:200

OK。

{
  "result" : {
    "issue" : {
      "id" : 2884248,
      "subject" : "33333",
      "author" : {
        "first_name" : "xxxxxx",
        "last_name" : "xxxxxx",
        "identifier" : "xxxxxx",
        "name" : "xxxxxx",
        "id" : 15533,
        "assigned_nick_name" : "xxxxxx"
      },
      "created_on" : "1754307805000",
      "updated_on" : "1754378971000",
      "start_date" : "1754323200000",
      "done_ratio" : 0,
      "description" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 作为 </span><用户角色></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 我想要 </span><结果></p><p><br></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 以便于 </span><目的>&nbsp;</p>",
      "expected_work_hours" : 0,
      "release_dev" : "",
      "project" : {
        "identifier" : "daba98e34f9348a48939b54ceb39ff5c",
        "name" : "ProjectTestCaseuDmT",
        "project_type" : "scrum",
        "id" : 6349386
      },
      "tracker" : {
        "name" : "Story",
        "id" : 7
      },
      "status" : {
        "name" : "新建",
        "id" : 1
      },
      "priority" : {
        "name" : "中",
        "id" : 2
      },
      "assigned_to" : {
        "first_name" : "xxxxxx",
        "last_name" : "xxxxxx",
        "identifier" : "xxxxxx",
        "name" : "xxxxxx",
        "id" : 15533,
        "assigned_nick_name" : "xxxxxx"
      },
      "developer" : { },
      "severity" : {
        "name" : "一般",
        "id" : 12
      },
      "domain" : { },
      "module" : { },
      "story_point" : {
        "id" : 3,
        "name" : "1"
      },
      "find_release_dev" : "",
      "assigned_cc_user" : [ ],
      "accessories_list" : [ {
        "attachment_id" : 26262,
        "issue_id" : 2884248,
        "container_type" : "Issue",
        "file_name" : "ProjectManPortal-CDN-urimapping.json",
        "disk_file_name" : "8b0eb921-1737-4429-afd9-bc09b54b5621.json",
        "digest" : "1",
        "creator_num_id" : 15533,
        "created_date" : "2025-08-04 19:43:46",
        "disk_directory" : "/daba98e34f9348a48939b54ceb39ff5c/projectMan/2884248/8b0eb921-1737-4429-afd9-bc09b54b5621.json",
        "creator_id" : "c2d89e38a64a466f8f945f595df4402d"
      } ],
      "custom_value_new" : { },
      "custom_fields" : [ ]
    }
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码

相关文档