华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 records Array of IssueAttrHistoryRecord objects 历史记录 total Integer 总数 表5 IssueAttrHistoryRecord 参数 参数类型 描述 field_key String 操作的字段 field_name String 操作字段的含义 id Long 历史记录id issue_id Long 工作项id new_value String 变更后的值,json字符串 old_value String 变更前的值,json字符串 operated_time Long 变更的时间 operation String 操作类型,新建，修改，删除 operator IssueUser object 操作者 property String 变更的属性 表6 IssueUser 参数 参数类型 描述 user_id String 用户uuid user_num_id Integer 用户数字id id Integer 用户id 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 { "records" : [ { "field_key" : "status", "field_name" : "状态", "id" : 789, "issue_id" : 123, "new_value" : "{\"id\":\"2\", \"name\":\"开发中\"}", "old_value" : "{\"id\":\"1\", \"name\":\"创建\"}", "operated_time" : 1601175640000, "operation" : "修改", "operator" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "张三" }, "property" : "attr" } ], "total" : 1 }

URI GET /v4/projects/{project_id}/issues/records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 从0开始,offset是limit的整数倍，limit=10,offset=0,10,20... 最小值：0 缺省值：0 limit 否 Integer 每页数量 最小1,最大100 最小值：1 最大值：100 缺省值：100 operated_time_interval 否 String 变更工作项的时间(查询的起始时间,查询的结束时间)

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 领域总数 domains Array of CreateProjectDomainResponseBody objects 领域列表 表5 CreateProjectDomainResponseBody 参数 参数类型 描述 domain_name String 领 域名 称 domain_id String 领域id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

URI GET /v4/projects/{project_id}/domains 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移量 缺省值：0 limit 否 Integer 一次返回的数据,最小1,最大100 最小值：1 最大值：100 缺省值：10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 demand_statistics Array of DemandStatisticResponseV4 objects 需求统计 表4 DemandStatisticResponseV4 参数 参数类型 描述 closed_num Integer 已关闭数量 module String 模块 new_num Integer 新建的数量 process_num Integer 开发中的数量 rejected_num Integer 已拒绝数量 solved_num Integer 已解决数量 test_num Integer 测试中的数量 total Integer 总数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "demand_statistics" : [ { "closed_num" : 1, "module" : "计费", "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1, "total" : 1 } ] }

响应示例 状态码： 200 OK { "total" : 1, "histories" : [ { "iteration_id" : 123454, "project_id" : "19274e1adffb4cc0b866ef6dd3ad0100", "operator" : { "user_id" : "0a938608ac00f2271f2ec01cccb94c19", "user_name" : "Banna", "nick_name" : "红海", "domain_id" : "9b33eb1d219140fea54d3b5ac689b073", "domain_name" : "devcloud_test" }, "operate" : "NEW", "operate_time" : "1665473746000", "details" : [ { "operate_field_name" : "name", "old_value" : null, "new_value" : "test" }, { "operate_field_name" : "description", "old_value" : null, "new_value" : null }, { "operate_field_name" : "end_time", "old_value" : null, "new_value" : "1664380800000" }, { "operate_field_name" : "status", "old_value" : null, "new_value" : "0" }, { "operate_field_name" : "begin_time", "old_value" : null, "new_value" : "1663776000000" }, { "operate_field_name" : "program_version_id", "old_value" : null, "new_value" : "-1" } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 histories Array of IterationHistory objects 历史记录 表5 IterationHistory 参数 参数类型 描述 iteration_id String 迭代ID project_id String 项目ID operator operator object 变更操作人 operate String 操作类型 operate_time String 操作时间 details Array of details objects 操作详情 表6 operator 参数 参数类型 描述 user_id String 用户uuid user_name String 用户名 nick_name String 昵称 domain_id String 租户uuid domain_name String 租户名 表7 details 参数 参数类型 描述 operate_field_name String 变更的字段 new_value String 操作后的值 old_value String 操作前的值 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

URI GET /v4/iterations/{iteration_id}/histories 表1 路径参数 参数 是否必选 参数类型 描述 iteration_id 是 Integer 迭代id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 最小值：0 缺省值：0 limit 否 Integer 每页数量，最大为100 最小值：1 最大值：100 缺省值：10

响应示例 状态码： 200 OK { "id" : 1221, "created_time" : "1597116605000", "records" : [ { "id" : 1234, "created_time" : 1617764919000, "user" : { "user_num_id" : 4091, "user_name" : "demo_user_name", "nick_name" : "aaa", "user_id" : "a360371833bf4c558f796fd707b44daf" }, "details" : [ { "property" : 1, "old_value" : 1, "new_value" : 2, "operation" : "批量编辑", "id" : 3597, "name" : "标题" } ] } ], "total" : 1 }

URI GET /v4/projects/{project_id}/issue/{issue_id}/records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度：32 最大长度：32 issue_id 是 Integer 工作项id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引，偏移量,offset是limit的整数倍，limit=10,offset=0,10,20... 最小值：0 缺省值：0 limit 否 Integer 每页显示的数量,每页最多显示100条 最小值：1 最大值：1000 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id Integer 操作记录id (已废弃) created_time Long 创建时间 (已废弃) records Array of IssueRecordV4 objects 历史记录 total Integer 操作记录总数 表5 IssueRecordV4 参数 参数类型 描述 id Integer 操作记录id created_time Long 操作记录创建时间 user user object 工作项操作的用户 details Array of details objects 操作的记录 表6 user 参数 参数类型 描述 user_num_id Integer 用户数字id user_name String 登录名 nick_name String 昵称 user_id String 用户32位的uuid 表7 details 参数 参数类型 描述 property String 操作属性 old_value String 上次的记录 new_value String 当前值 operation String 操作 id Integer 操作记录的id name String 操作的字段 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 datas Array of IssueCustomField objects 自定义字段返回数据 表5 IssueCustomField 参数 参数类型 描述 name String 自定义字段 custom_field String 自定义字段 options String 自定义字段的可选值，多个值以英文逗号区分 type String 自定义字段类型， textArea 多行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符； text 单行文本， 只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符； select 下拉框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； number 数字，取值范围由用户创建自定义字段时设置； date 日期 精确到年月日， time_date 日期 精确到时分秒， 长整型时间戳； checkbox 多选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； radio 单选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； tracker_ids Array of integers 自定义字段支持的工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story create_time String 自定义字段创建时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "datas" : [ { "name" : "selectName", "custom_field" : "custom_field16", "options" : "selectName1,selectName2", "type" : "ratio", "tracker_ids" : [ 7 ], "create_time" : "2023-05-17T09:50:04+08:00" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 custom_fields 否 Array of strings 自定义字段 names 否 Array of strings 自定义字段页面显示的含义 included_not_in_use 否 Boolean 查询结果是否包括未使用的自定义字段，默认仅查询使用中的自定义字段，设为true时查询项目中所有自定义字段

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 评论总数 comments Array of IssueCommentV4 objects 评论列表 表5 IssueCommentV4 参数 参数类型 描述 comment String 评论内容 id Integer 评论id created_time String 评论时间 timestamp String 评论时间戳 user CommentUserV4 object 发表评论用户信息 表6 CommentUserV4 参数 参数类型 描述 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 错误码

URI GET /v4/projects/{project_id}/issues/{issue_id}/comments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度：32 最大长度：32 issue_id 是 Integer 工作项id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引，偏移量 最小值：0 缺省值：0 limit 否 Integer 每页显示的条数,最大显示100条 最小值：1 最大值：100 缺省值：10

响应示例 状态码： 200 OK { "status" : "success", "result" : { "data" : [ { "display_name" : "小标题", "code" : "c7186197833374113792", "id" : "994277015639076864", "description" : "222222222222", "created_by" : "测试昵称", "created_date" : "1715305846000", "modified_by" : "测试昵称", "definition_type" : "4", "field_type_name" : "多行文本", "required" : false, "controlled" : false, "immutable" : false, "no" : 9999 } ], "total" : 1 } }

URI GET /v1/ipdprojectservice/projects/{project_id}/fields 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目Id 表2 Query参数 参数 是否必选 参数类型 描述 keyword 否 String 关键字搜索支持标题、字段类型、创建人搜索 offset 是 Integer 分页偏移量，从0开始，取值为limit的倍数 limit 是 Integer 分页大小

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求失败信息 result FieldListResult object 字段列表 表4 FieldListResult 参数 参数类型 描述 data Array of FieldEntity objects 字段列表 total Integer 项目内字段总数 表5 FieldEntity 参数 参数类型 描述 display_name String 字段显示名 code String 字段code id String 字段id description String 字段描述 created_by String 字段创建人显示名 created_date String 字段创建时间 modified_by String 字段最后更新人显示名 definition_type String 字段级别 1,2,3为系统字段，4为租户字段，5为项目字段 field_type_name String 字段类型名称 required Boolean 字段在工作项中是否必填，为true表示必填。和工作流配置不一致时以工作流为准 controlled Boolean 字段在工作项中是否受控，为true表示受控。修改已基线的工作项受控字段需要走变更评审流程。和工作流配置不一致时以工作流为准 immutable Boolean 字段在工作项中是否可修改，为true时不可修改。和工作流配置不一致时以工作流为准 no Integer 字段排序的序号 all_options Array of OptionEntity objects 字段选项 表6 OptionEntity 参数 参数类型 描述 id String 选项id code String 选项code值 display_value String 选项显示名称 value String 选项唯一标识 level Integer 选项层级。用于区分层级字段的层级，层级字段最多4层 sequence Integer 选项顺序

URI GET /v1/ipdprojectservice/projects/{project_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目Id 表2 Query参数 参数 是否必选 参数类型 描述 label_type 否 String 标签归属的工作项分类，不传该参数时默认查询所有类型下的标签 feature：特性 raw requirement：原始需求 requirement：研发需求 task：任务 bug：缺陷 title 否 String 标签名称

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result LabelListResponse object 标签详情 status String 请求状态 message String 请求错误信息 表4 LabelListResponse 参数 参数类型 描述 data Array of LabelEntity objects 标签列表 total Integer 标签总数 表5 LabelEntity 参数 参数类型 描述 id String 标签id label_type String 标签所属工作项类型，对应工作项的type字段 color String 标签颜色RGB title String 标签标题

响应示例 状态码： 200 OK { "status" : "success", "result" : { "data" : [ { "id" : "1030082514003210240", "label_type" : "bug", "color" : "#A97AF8", "title" : "Bug11" } ], "total" : 7 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 projects Array of projects objects 项目信息列表 数组长度：0 - 1000 total Integer 总数 最小值：0 最大值：10000 表4 projects 参数 参数类型 描述 project_num_id Integer 项目数字id project_id String 项目id 最小长度：32 最大长度：32 project_name String 项目名 最小长度：1 最大长度：128 description String 项目描述 created_time Long 项目创建时间 最小长度：0 最大长度：13 updated_time Long 项目更新时间 最小长度：0 最大长度：13 project_type String 项目类型 creator creator object 创建者信息 表5 creator 参数 参数类型 描述 user_num_id Integer 创建人numId user_id String 创建人id 最小长度：1 最大长度：32 user_name String 创建人姓名 domain_id String 创建人租户id 最小长度：1 最大长度：32 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 { "projects" : [ { "project_num_id" : 3056544, "project_id" : "e2da96a5d2c845e284f0ad47f8ca8cb1", "project_name" : "demo_project", "description" : "这是一个demo", "created_time" : "1571296951000", "updated_time" : "1571296951000", "project_type" : "scrum", "creator" : { "user_num_id" : 4097, "user_id" : "c4bd39f0573a436589714bedbcca8536", "user_name" : "modile_user", "domain_id" : "2489d8cbba804db8bcd35384685ff3ac", "domain_name" : "modile_user", "nick_name" : "Tom.M.Riddle" } } ], "total" : 1 }

URI GET /v4/projects/domain/not-added 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引，偏移量,offset是limit的整数倍，limit=10,offset=0,10,20... 最小值：0 缺省值：0 limit 否 Integer 每页显示的数量,每页最多显示100条 最小值：1 最大值：100 缺省值：10

响应示例 状态码： 200 OK { "issues" : [ { "actual_work_hours" : 0, "assigned_cc_user" : [ { "id" : 4091, "name" : "demo_user_name", "nick_name" : "张三" } ], "assigned_user" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "张三" }, "begin_time" : "2020-09-12", "created_time" : "2020-09-13 14:40:11", "creator" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "张三" }, "custom_fields" : [ { "name" : "customField16", "value" : "多选框", "new_name" : "custom_field16" } ], "new_custom_fields" : [ { "custom_field" : "custom_field16", "field_name" : "field_name", "value" : "多选框1,多选框2" } ], "developer" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "张三" }, "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" : "迭代1" }, "module" : { "id" : 456, "name" : "Project" }, "name" : "国际化整改", "parent_issue" : { "id" : 123, "name" : "提供查询项目成员的功能" }, "priority" : { "id" : 1, "name" : "低" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "tracker" : { "id" : 7, "name" : "story" }, "updated_time" : "2020-09-14 14:40:11", "closed_time" : "2020-09-15 14:40:11" } ], "total" : 1 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 issues Array of IssueResponseV4 objects 工作项列表 total Integer 总数 表4 IssueResponseV4 参数 参数类型 描述 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 NewCustomField 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 迭代 module module object 模块 name String 标题 parent_issue parent_issue object 父工作项 priority priority object 工作项优先级 order order object 工作项优先级顺序 severity severity object 工作项重要程度 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 关闭时间 年-月-日 时:分:秒 表5 IssueUser 参数 参数类型 描述 user_id String 用户uuid user_num_id Integer 用户数字id id Integer 用户id name String 用户名 nick_name String 昵称 表6 CustomField 参数 参数类型 描述 name String 自定义属性名 value String 自定义属性对应的值 new_name String 自定义属性名 表7 NewCustomField 参数 参数类型 描述 custom_field String 自定义字段 field_name String 自定义字段名称 value String 自定义属性对应的值，多个值以英文逗号区分开 表8 domain 参数 参数类型 描述 id Integer 领域id name String 领域 表9 IssueProjectResponseV4 参数 参数类型 描述 project_id String 项目id project_name String 项目名称 project_num_id Integer 项目数字id 表10 iteration 参数 参数类型 描述 id Integer 迭代id name String 迭代名 表11 module 参数 参数类型 描述 id Integer 模块id name String 模块 表12 parent_issue 参数 参数类型 描述 id Integer 父工作项id name String 父工作项 表13 priority 参数 参数类型 描述 id Integer 优先级id name String 优先级 表14 order 参数 参数类型 描述 id Integer 优先级顺序id name String 优先级顺序名称 表15 severity 参数 参数类型 描述 id Integer 重要程度id name String 重要程度 表16 status 参数 参数类型 描述 id Integer 状态id name String 状态名称 表17 env 参数 参数类型 描述 id Integer 缺陷发现环境id name String 缺陷发现环境名称 表18 tracker 参数 参数类型 描述 id Integer 类型id name String 类型名称 状态码： 400 表19 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 401 表20 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 ok { "test_cases" : [ { "case_id" : "36cfaab019dc49cdb53b07aefe553f5a", "case_num" : "1", "case_name" : "demo", "case_level" : "2", "status" : { "id" : "1", "name" : "未开始" }, "creator" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear1" }, "owner" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear1" }, "project" : { "project_name" : "demo", "project_id" : "58d9050550c847c89885c1797a718b0c" }, "is_base_line" : 0, "type" : "1", "created_time" : 1233445566000 } ], "total" : 0 }