查询关联工作项V2
功能介绍
查询关联工作项信息V2。
调用方法
请参见如何调用API。
URI
GET /v2/issues/inquire-associate
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_no |
否 |
Integer |
参数解释: 分页索引。 约束限制: 不涉及 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
page_size |
否 |
Integer |
参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
issue_id |
是 |
Integer |
参数解释: 工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10。 默认取值: 不涉及。 |
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 返回结果。 |
status |
String |
参数解释: 返回状态。 取值范围: success,error。 |
参数 |
参数类型 |
描述 |
---|---|---|
issues |
Array of IssuesAssociate objects |
参数解释: 关联的子工作项信息。 |
total_count |
Integer |
参数解释: 关联工作项的总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
identifier |
String |
参数解释: 关联工作项所属项目uuid。 取值范围: 不涉及。 |
project_type |
String |
参数解释: 项目类型。 取值范围: "scrum"。 |
new_status_name |
String |
参数解释: 关联工作项的新状态名称(示例:新建)。 取值范围: 不涉及。 |
status_attribute_name |
String |
参数解释: 关联工作项的状态分类。 取值范围: 开始态/进行态/结束态。 |
subject |
String |
参数解释: 关联工作项的标题。 取值范围: 不涉及。 |
status_name |
String |
参数解释: 关联工作项的状态名称。 取值范围: 不涉及。 |
project_name |
String |
参数解释: 关联工作项所属项目名称。 取值范围: 不涉及。 |
status_id |
Integer |
参数解释: 关联工作项的状态id。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 关联工作项的id。 取值范围: 不涉及。 |
assigned_to |
AssignedAssociate object |
参数解释: 关联工作项的当前责任人。 |
参数 |
参数类型 |
描述 |
---|---|---|
assigned_user_num_id |
Integer |
参数解释: 用户的数字id。 取值范围: 不涉及。 |
assigned_nick_name |
String |
参数解释: 用户的昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 有租户信息的用户名。 取值范围: 不涉及。 |
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
assigned_user_id |
String |
参数解释: 用户的32位uuid。 取值范围: 不涉及。 |
first_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
请求示例
GET http://{endpoint}/v2/issues/inquire-associate??project_id=c15cc54e338d4506afd9bd8103071ff0&issue_id=9132318&page_no=1&page_size=10
响应示例
状态码:200
OK
{ "result" : { "associateIssues" : { "total_count" : 2, "issues" : [ { "identifier" : "c15cc54e338d4506afd9bd8103071ff0", "project_type" : "scrum", "new_status_name" : "新建", "status_attribute_name" : "开始态", "subject" : "5555", "status_name" : "新建", "project_name" : "Scrum0610ceshi", "status_id" : 1, "id" : 9184456, "assigned_to" : { "first_name" : "xxxxxx", "assigned_user_num_id" : 1111, "assigned_nick_name" : "xxxxxx", "name" : "xxxxxx", "last_name" : "xxxxxx", "assigned_user_id" : "xxxxxx" } }, { "identifier" : "c15cc54e338d4506afd9bd8103071ff0", "project_type" : "scrum", "new_status_name" : "新建", "status_attribute_name" : "开始态", "subject" : "啊啊啊啊", "status_name" : "新建", "project_name" : "Scrum0610ceshi", "status_id" : 1, "id" : 9178848, "assigned_to" : { "first_name" : "xxxxxx", "assigned_user_num_id" : 1111, "assigned_nick_name" : "xxxxxx", "name" : "xxxxxx", "last_name" : "xxxxxx", "assigned_user_id" : "xxxxxx" } } ] } }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。