文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 详情页的关于工作项的各项指标个数
更新时间:2025-08-11 GMT+08:00
分享

详情页的关于工作项的各项指标个数

功能介绍

详情页的关于工作项的各项指标个数。

调用方法

请参见如何调用API

URI

GET /v3/workitem/scrum/index-count

表1 Query参数

参数

是否必选

参数类型

描述

issue_id

Integer

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及。

project_uuid

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态

取值范围:

success:返回成功

error :返回失败

表4 result

参数

参数类型

描述

related_issue_count

Integer

参数解释:

关联工作项的总数。

取值范围:

不涉及。

related_wiki_count

Integer

参数解释:

关联wiki的总数。

取值范围:

不涉及。

related_test_case_count

Integer

参数解释:

关联测试用例的总数。

取值范围:

不涉及。

related_test_plan_count

Integer

参数解释:

关联测试计划的总数。

取值范围:

不涉及。

code_commit_count

Integer

参数解释:

代码提交记录的总数。

取值范围:

不涉及。

code_branch_count

Integer

参数解释:

代码分支的总数。

取值范围:

不涉及。

code_mergerequest_count

Integer

参数解释:

代码合入请求的总数。

取值范围:

不涉及。

请求示例

GET https://{engdpoint}/v3/workitem/scrum/index-count?issue_id=2884417&project_uuid=310eed4d6160446cb294a8bacfd46e7e

响应示例

状态码:200

OK。

{
  "result" : {
    "related_issue_count" : 0,
    "related_wiki_count" : 0,
    "related_test_case_count" : 0,
    "related_test_plan_count" : 0,
    "code_commit_count" : 0,
    "code_branch_count" : 0,
    "code_mergerequest_count" : 0
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码

相关文档