华为云用户手册

API概览 表1 API概览 类型 说明 Scrum项目的工作项 Scrum项目工作项的创建、删除、修改、查询等相关接口。 Scrum项目的迭代 Scrum项目迭代的创建、删除、修改、查询等相关接口。 用户信息 获取当前用户信息，更新用户昵称，获取当前用户角色。 项目成员 添加、查询、删除、退出项目成员等接口信息。 项目信息 创建、更新、查询、删除项目等相关的接口。 项目指标 查询人均bug，查询需求按时完成率，查询缺陷密度。 项目统计 获取bug，需求统计信息，获取项目概览。 看板项目的工作项 查询看板项目下工作项的相关接口。 Scrum项目的模块 Scrum项目模块的创建、查询、更新和删除相关接口。 Scrum项目的领域 Scrum项目领域的创建、查询、更新和删除相关接口。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释：用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制：不涉及 取值范围：最小长度：10，最大长度：32768 默认取值：不涉及 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 参数解释：图片文件 约束限制：图片大小上限 5M 取值范围：不涉及 默认取值：不涉及

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 img_id String 图片id img_url String 图片url v1改成v3作为下载图片请求 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id Integer 关联id issue_id Integer 工作项id project_id String 项目id disk_filename String 云盘存贮名 file_name String 文件名 size String 文件大小 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 project_name 是 String 项目名 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 模块描述 module_name 是 String 模块名称 owner 是 UserRequest object 模块责任人 表4 UserRequest 参数 是否必选 参数类型 描述 user_id 是 String 用户32位字符串id

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 description String 模块描述 module_name String 模块名称 module_id Integer 模块id owner ModuleOwner object 模块责任人 表6 ModuleOwner 参数 参数类型 描述 user_id String 用户32位字符串id user_num_id Integer 用户数字id user_name String 用户名称 nick_name String 用户昵称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "description" : "module name", "module_name" : "demo", "module_id" : 46691, "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2", "user_num_id" : 4091, "user_name" : "demo_user_name_06", "nick_name" : "demo" } }

请求示例 PUT https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/modules/662086 { "description" : "module demo", "module_name" : "demo", "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 domain_name String 领 域名 称 domain_id String 领域id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：10 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 role_id 是 Integer 成员角色, -1 项目创建者, 3 项目经理, 4 开发人员, 5 测试经理, 6 测试人员, 7 参与者, 8 浏览者, 9 运维经理 user_ids 是 Array of strings 用户id

请求示例 Put https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/iteration/11225793 { "end_time" : "2018-07-05", "name" : "sttes32s3", "begin_time" : "2018-1-31", "description" : "" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of WorkItemStatusFlowVo objects 流转数据 表5 WorkItemStatusFlowVo 参数 参数类型 描述 parent_name String 父状态的名称 parent_type String 父状态的类型 status_id String 状态id name String 状态名称 status_type String 状态类型 direct_to Array of StatusFlowDirectToVo objects 流转到的数据 assign_to String 处理人的uuid comment String 评论内容 required_assign Boolean 处理人是否必填 required_notes Boolean 评论是否必填 field_type Boolean 是否是字段值，true 处理人的信息是字段值， false 处理人的值是用户的信息,固定值 parent_id String 父状态的uuid 表6 StatusFlowDirectToVo 参数 参数类型 描述 parent_name String 父状态的名称 parent_type String 父状态的类型 status_id String 状态id name String 状态名称 status_type String 状态类型 enabled Boolean 是否已开启状态流转， true： 开启, false 没开启 parent_id String 父状态的uuid 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "workflows" : [ { "parent_name" : "进行中", "parent_type" : "IN_PROGRESS", "status_id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "研发", "status_type" : "IN_PROGRESS", "direct_to" : [ { "parent_name" : "进行中", "parent_type" : "IN_PROGRESS", "status_id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "研发", "status_type" : "IN_PROGRESS", "enabled" : false, "parent_id" : "beda5e42974c42a09e142faa1dc0fc98" } ], "assign_to" : "a360371833bf4c558f796fd707b44daf", "comment" : "A transfer to B", "required_assign" : false, "required_notes" : false, "field_type" : false, "parent_id" : "beda5e42974c42a09e142faa1dc0fc98" } ] }

请求示例 GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/workflow/config?board_id=5aef890d5a2d45b2b22f3e307e785715 GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/workflow/config?board_id=5aef890d5a2d45b2b22f3e307e785715

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：10 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 user_ids 否 Array of strings 查询的用户id列表 work_hours_types 否 String 工时类型，以逗号分隔,21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App),26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假 work_hours_dates 否 String 工时日期，以逗号分隔，年-月-日 begin_time 否 String 工时开始日期，年-月-日 end_time 否 String 工时结束日期，年-月-日 offset 是 Integer 偏移量,offset是limit的整数倍，limit=10,offset=0,10,20... 最小值：0 缺省值：0 limit 是 Integer 每页显示数量，每页最多显示100条 最小值：1 最大值：100 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 work_hours Array of work_hours objects 工时列表 total Integer 总数 表5 work_hours 参数 参数类型 描述 project_name String 项目名称 nick_name String 用户昵称 user_id String 用户id user_name String 用户名 work_date String 工时日期 work_hours_num String 工时花费 summary String 工时内容 work_hours_type_name String 工时类型 issue_id Integer 工作项id issue_type String 工作项类型 subject String 工作项标题 created_time String 工作项创建时间 closed_time String 工作项结束时间 work_hours_created_time String 工时创建时间 work_hours_updated_time String 工时更新时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 ok { "work_hours" : [ { "project_name" : "demo", "nick_name" : "demo", "user_id" : "09d75cdd9a00d44d2f17c01875483f26", "user_name" : "userName", "work_date" : "2020-02-19", "work_hours_num" : "2.0", "summary" : "summaryXXXXX", "work_hours_type_name" : "后端开发", "issue_id" : 123456, "issue_type" : "Story", "subject" : "title", "created_time" : "2019-12-17", "closed_time" : "2019-12-20", "work_hours_created_time" : "2019-12-17 09:00:00", "work_hours_updated_time" : "2019-12-20 15:00:00" } ], "total" : 1 }

响应示例 状态码： 200 OK { "bug_statistics" : [ { "critical_num" : 0, "defect_index" : 1, "module" : "统计分数", "normal_num" : 1, "serious_num" : 0, "tip_num" : 0, "total" : 1 } ], "demand_statistics" : [ { "closed_num" : 1, "module" : "计费", "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1, "total" : 1 } ], "issue_completion_rates" : [ { "issue_status" : { "closed_num" : 1, "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1 }, "tracker_id" : 0 } ], "project_id" : "526cefde62004de2b62b5e8dd2c2b3af" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 bug_statistics Array of BugStatisticResponseV4 objects bug统计列表 demand_statistics Array of DemandStatisticResponseV4 objects 按模块统计列表 issue_completion_rates Array of IssueCompletionRateResponseV4 objects 按工作项类型统计列表 project_id String 项目的32位id，项目唯一标识 表4 BugStatisticResponseV4 参数 参数类型 描述 critical_num Integer 重要程度为关键的缺陷数，重要程度为关键对应id为10 defect_index Double DI值，不同重要程度的缺陷对应不同的分值 module String 模块 normal_num Integer 重要程度为一般的缺陷数，重要程度为一般对应id为12 serious_num Integer 重要程度为严重的缺陷数，重要程度为严重对应id为11 tip_num Integer 重要程度为提示的缺陷数，重要程度为提示对应id为13 total Integer 当前项目下bug统计总数 表5 DemandStatisticResponseV4 参数 参数类型 描述 closed_num Integer 按模块统计已关闭数量 module String 模块 new_num Integer 按模块统计新建的数量 process_num Integer 按模块统计开发中的数量 rejected_num Integer 按模块统计已拒绝数量 solved_num Integer 按模块统计已解决数量 test_num Integer 按模块统计测试中的数量 total Integer 按模块统计总数 表6 IssueCompletionRateResponseV4 参数 参数类型 描述 issue_status IssueStatusResponseV4 object 工作项状态维度的统计信息 tracker_id Integer 工作项类型,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story 表7 IssueStatusResponseV4 参数 参数类型 描述 closed_num Integer 当前项目中工作项已关闭数量 new_num Integer 当前项目中工作项新建的数量 process_num Integer 当前项目中工作项开发中的数量 rejected_num Integer 当前项目中工作项已拒绝数量 solved_num Integer 当前项目中工作项已解决数量 test_num Integer 当前项目中工作项测试中的数量 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 project project object 项目信息 表4 project 参数 参数类型 描述 project_num_id Integer 项目numId project_id String 项目uuid name String 项目名称 created_on Long 项目创建时间 updated_on Long 项目更新时间 project_type String 项目类型 archive Integer 是否归档 enterprise_id String 企业项目id project_code String 项目代号 creator creator object 创建者信息 表5 creator 参数 参数类型 描述 user_num_id Integer 创建人num_id user_id String 创建人uuid user_name String 创建人姓名 domain_id String 创建人租户id domain_name String 创建人租户名称 nick_name String 创建人昵称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "project" : { "project_num_id" : 3183801, "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8", "name" : "demo_project", "created_on" : 1576114296000, "updated_on" : 1576114296000, "project_type" : "scrum", "archive" : 1, "enterprise_id" : "041bd3eab86544863b8f92ffcd35e218", "project_code" : "abc_123", "creator" : { "user_num_id" : 4097, "user_id" : "c4bd39f0573a436589714bedbcca8536", "user_name" : "modile_user", "domain_id" : "2489d8cbba804db8bcd35384685ff3ac", "domain_name" : "modile_user", "nick_name" : "Tom.M.Riddle" } } }

响应示例 状态码： 200 OK { "begin_time" : "2020-07-12", "charts" : [ { "date" : "2020-09-12", "finished_num" : 1, "iteration_id" : 3789, "project_num_id" : 36587463, "remaining_num" : 3, "total" : 4 } ], "closed_total" : 1, "created_time" : "2020-06-31 09:10:03", "end_time" : "2020-07-19", "have_task" : false, "iteration_id" : 35789, "name" : "迭代1", "opened_total" : 3, "progress" : "25%", "total" : 4, "updated_time" : "2020-06-31 09:10:03", "status" : "0" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 begin_time String 迭代结束时间，年-月-日 charts Array of Chart objects 燃尽图 closed_total Integer 已关闭的工单数 created_time String 迭代创建时间 end_time String 迭代开始时间，年-月-日 have_task Boolean 是否有task iteration_id Integer 迭代id name String 迭代标题 opened_total Integer 开启的工单数 progress String 工作进展 total Integer 工单总数 updated_time String 迭代更新时间 status String 迭代的状态,0 未开始，1 进行中，2 结束 表4 Chart 参数 参数类型 描述 date String 统计时间 finished_num Integer 完成story工单 iteration_id Integer 迭代id project_num_id Integer 项目id remaining_num Integer 未完成story数 total Integer 总story数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求示例 GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7 GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of ScrumStatusFlowVo objects 流转数据 表5 ScrumStatusFlowVo 参数 参数类型 描述 id String 流转数据的uuid name String 状态名称 status_id Integer 状态id direct_to Array of ScrumStatusFlowDirectToVo objects 流转到的数据 表6 ScrumStatusFlowDirectToVo 参数 参数类型 描述 id String 流转数据的uuid status_id Integer 状态id name String 状态名 enabled Boolean 是否开启流转 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "workflows" : [ { "id" : "2e645dbab6874a3eafa77ef06b97ea75", "name" : "新建", "status_id" : 1, "direct_to" : [ { "id" : "2e645dbab6874a3eafa77ef06b97ea75", "status_id" : 2, "name" : "新建", "enabled" : true } ] } ] }

URI GET /v4/projects/{project_id}/issues/workflow/config 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 tracker_id 是 Integer 工作项类型id [2,3,4,5,6,7]

响应示例 状态码： 200 OK { "issue_completion_rates" : [ { "issue_status" : { "closed_num" : 0, "new_num" : 0, "process_num" : 0, "rejected_num" : 0, "solved_num" : 0, "test_num" : 0 }, "tracker_id" : 3 } ], "total" : 2 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 issue_completion_rates Array of issue_completion_rates objects 不同类型的工作项完成率 total Integer 总数 表4 issue_completion_rates 参数 参数类型 描述 issue_status issue_status object 工作项不同状态下的数量 tracker_id Integer 工作项类型id,1需求,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story 表5 issue_status 参数 参数类型 描述 closed_num Integer 已关闭的工作项 new_num Integer 新建的工作项 process_num Integer 进行中的工作项数目 rejected_num Integer 已经拒绝的工作项 solved_num Integer 已经解决的工作项 test_num Integer 测试中的工作项 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码