华为云用户手册

  • URI GET /v4/projects/{project_id}/work-hours-type 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的数量,默认显示10条,最多显示100条 最小值:1 最大值:100 缺省值:10 offset 否 Integer 分页索引,偏移量offset是limit的整数倍,limit=10,offset=0,10,20... 最小值:0 缺省值:0 status 否 Integer 工时类型状态,支持按状态筛选查询,置空时查询所有工时类型,1表示查询启用的工时类型,2表示查询未启用的工时类型
  • 请求示例 Post https://{endpoint}/v4/projects/work-hours { "limit" : 1, "offset" : 0, "end_time" : "2020-08-14", "project_ids" : [ "e2da96a5d2c845e284f0ad47f8ca8cb2", "a2da96a5d2c845e284f0ad47f8ca8cef" ] }
  • 响应示例 状态码: 200 ok { "work_hours" : [ { "project_name" : "项目名称", "nick_name" : "用户昵称", "user_id" : "09d75cdd9a00d44d2f17c01875483f26", "user_name" : "用户名", "work_date" : "2020-02-19", "work_hours_num" : "2.0", "summary" : "做了XXXXX", "work_hours_type_name" : "后端开发", "issue_id" : 123456, "issue_type" : "Story", "subject" : "工作项标题", "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 }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 表2 请求Body参数 参数 是否必选 参数类型 描述 project_ids 否 Array of strings 查询的项目id列表 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 limit 是 Integer 每页显示数量,每页最多显示100条 最小值:1 最大值:100
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 work_hours Array of work_hours objects 工时列表 total Integer 总数 表4 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 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 members Array of members objects 项目成员列表 total Integer 总数 表5 members 参数 参数类型 描述 domain_id String 租户id 最小长度:32 最大长度:32 domain_name String 租户名 user_id String 用户id user_name String 用户名 user_num_id Integer 创建人numId role_id Integer 成员角色, -1 项目创建者, 3 项目经理, 4 开发人员, 5 测试经理, 6 测试人员, 7 参与者, 8 浏览者, 9 运维经理 nick_name String 用户昵称 role_name String 用户角色 user_type String 用户类型, User iam用户, Federation 联邦账号, forbidden Integer 是否是禁用账号,1 禁用账号, 0非禁用账号 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 OK { "members" : [ { "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "demo_user_name", "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name", "user_num_id" : 4097, "role_id" : 7, "nick_name" : "name", "role_name" : "项目创建者", "user_type" : "User", "forbidden" : 0 } ], "total" : 1 }
  • URI GET /v4/projects/{project_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引,偏移量,offset是limit的整数倍,limit=10,offset=0,10,20... 最小值:0 最大值:10000 缺省值:0 limit 否 Integer 每页显示的数量,每页最多显示100条 最小值:1 最大值:100 缺省值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 迭代总数 iterations Array of iterations objects 迭代信息 表5 iterations 参数 参数类型 描述 description String 迭代描述 end_time String 迭代结束时间 id Integer 迭代id name String 迭代标题 begin_time String 迭代开始时间 status String 迭代状态 updated_time Long 迭代更新时间,长整型时间戳 deleted Boolean 迭代是否已经删除,false, 未删除, true已经删除 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 OK { "total" : 3, "iterations" : [ { "description" : "description", "end_time" : "2019-10-17", "id" : 9725885, "name" : "完成html", "begin_time" : "2019-10-10", "status" : "0", "updated_time" : 1640231944000, "deleted" : false } ] }
  • URI GET /v4/projects/{project_id}/iterations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 updated_time_interval 否 String 更新迭代的时间(查询的起始时间,查询的结束时间) include_deleted 否 Boolean 是否包含被删除的迭代,默认false不包含被删除的迭代
  • 响应参数 状态码: 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 { "bug_statistics" : [ { "critical_num" : 0, "defect_index" : 1, "module" : "统计分数", "normal_num" : 1, "serious_num" : 0, "tip_num" : 0, "total" : 1 } ] }
  • URI GET /v4/projects/{project_id}/bug-statistic 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 bug_statistics Array of BugStatisticResponseV4 objects 当前项目下bug统计信息 表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统计总数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 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 { "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" : "低" }, "order" : { "id" : 1, "name" : "1" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "release_dev" : "0727", "find_release_dev" : "0728", "env" : { "id" : 36, "name" : "测试环境" }, "tracker" : { "id" : 7, "name" : "story" }, "updated_time" : "2020-09-14 14:40:11", "closed_time" : "2020-09-15 14:40:11", "deleted" : false } ], "total" : 1 }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 issues Array of ListIssueItemResponse objects 工作项列表 total Integer 工作项总数 表6 ListIssueItemResponse 参数 参数类型 描述 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 工作项编号 project IssueProjectResponseV4 object 项目信息 iteration iteration object 迭代 module module object 模块 name String 工作项标题 parent_issue parent_issue object 当前工作项的父工作项信息 priority priority object 优先级,可选值:1 '低',2 '中',3 '高' order order object 工作项优先级顺序 severity severity object 重要程度, 13 '提示',12 '一般',11'重要',10 '关键' 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 关闭时间 年-月-日 时:分:秒 deleted Boolean 是否已经删除,true 已经删除, false 未删除 表7 IssueUser 参数 参数类型 描述 user_id String 用户32位uuid,用户唯一标识,需要通过IAM获取 user_num_id Integer 用户数字id id Integer 用户id name String 用户名 nick_name String 用户昵称 表8 CustomField 参数 参数类型 描述 name String 自定义字段名 value String 自定义字段名对应的值 new_name String 自定义字段名 表9 NewCustomField 参数 参数类型 描述 custom_field String 自定义字段 field_name String 自定义字段名称 value String 自定义字段对应的值,多个值以英文逗号区分开 表10 domain 参数 参数类型 描述 id Integer 领域id name String 领域名 表11 IssueProjectResponseV4 参数 参数类型 描述 project_id String 项目32为uuid,唯一标识,可通过IAM获取 project_name String 项目名称 project_num_id Integer 项目数字id 表12 iteration 参数 参数类型 描述 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,1 '低',2 '中',3 '高' name String 优先级,'低','中','高' 表16 order 参数 参数类型 描述 id Integer 优先级顺序id,例:1 name String 优先级顺序名称,例“1” 表17 severity 参数 参数类型 描述 id Integer 工作项重要程度id,13 '提示',12 '一般',11'重要',10 '关键' name String 工作项重要程度名称, '提示','一般','重要','关键' 表18 status 参数 参数类型 描述 id Integer 工作项状态id,新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 name String 工作项状态名称,新建, 进行中, 已解决, 测试中, 已关闭, 已拒绝 表19 env 参数 参数类型 描述 id Integer 缺陷发现环境id(该字段仅Bug类型工作项拥有) name String 缺陷发现环境名称(该字段仅Bug类型工作项拥有) 表20 tracker 参数 参数类型 描述 id Integer 工作项类型id,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story name String 工作项类型名称, 任务/Task, 缺陷/Bug, Epic, Feature, Story 状态码: 400 表21 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表22 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 assigned_ids 否 Array of integers 参数解释:处理人id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 creator_ids 否 Array of integers 参数解释:创建者id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 developer_ids 否 Array of integers 参数解释:开发人id, 可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 domain_ids 否 Array of integers 参数解释:领域id, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性' 约束限制:正则表达式,^\d+$ 取值范围:最小值 14 最大值 20 默认取值:不涉及 done_ratios 否 Array of integers 参数解释:工作项完成度 约束限制:0 '0%'(输入数字0代表完成度为0%的工作项), 10 '10%', 20 '20%' , 30 '30%', 40 '40%', 50 '50%', 60 '60%', 70 '70%' 80 '80%', 90 '90%', 100 '100%' 取值范围:最小值 0 最大值 100 默认取值:不涉及 iteration_ids 否 Array of integers 参数解释:迭代id,可通过ListProjectIterationsV4接口获取指定项目的迭代列表 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 limit 否 Integer 参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 offset 否 Integer 参数解释:偏移量 offset是limit的整数倍数,limit=10,offset=0,10,20... 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0 module_ids 否 Array of integers 参数解释:模块id, 设置-工作项设置-模块设置内用户可新建模块 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 priority_ids 否 Array of integers 参数解释: 优先级, 约束限制:正则表达式,^\d+$ 取值范围:1 低, 2 中, 3 高, 默认取值:不涉及 query_type 否 String 参数解释: 查询类型, 约束限制:正则表达式,^(epic|feature|backlog|\s*)$ 取值范围:backlog(Story|Task|Bug), feature, epic 默认取值:backlog severity_ids 否 Array of integers 参数解释: 重要程度, 约束限制:正则表达式,^\d+$ 取值范围:10 关键, 11 重要, 12 一般, 13 提示, 默认取值:不涉及 status_ids 否 Array of integers 参数解释: 状态id, 约束限制:正则表达式,^\d+$ 取值范围:新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 默认取值:不涉及 story_point_ids 否 Array of integers 参数解释: 故事点id, 故事点是一种基于敏捷的估算工作量方法,故事点综合了交付Story所付出的所有努力、开发复杂度、风险,可以简单理解为开发所需要的成本。 约束限制:正则表达式,^\d+$ 取值范围:(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 分别对应故事点值0, 1/2, 1, 2, 3, 5, 8, 13, 21, 40, 80, 100) 默认取值:不涉及 tracker_ids 否 Array of integers 参数解释: 工作项类型, 约束限制:任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 取值范围:最小值 2 最大值 7 默认取值:不涉及 include_deleted 否 Boolean 参数解释: 查询条件是否包含已删除工作项 约束限制:正则表达式,^(true|false)$ 取值范围:true 查询的工作项包含已经逻辑删除的,false 查询的工作项不包含已经删除的 默认取值:不涉及 created_time_interval 否 String 参数解释: 创建工作项的时间(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及 updated_time_interval 否 String 参数解释: 根据工作项的更新时间查询工作项,(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及 closed_time_interval 否 String 参数解释: 根据工作项的结束时间查询工作项,(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及 custom_fields 否 Array of custom_fields objects 参数解释: 用户自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 表4 custom_fields 参数 是否必选 参数类型 描述 custom_field 否 String 参数解释: 自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 value 否 String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的options值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及
  • 响应示例 状态码: 200 OK { "issues" : [ { "actual_work_hours" : 10, "assigned_user" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "demo" }, "author" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "demo" }, "begin_time" : 1590940800000, "closed_time" : 1590940800000, "created_time" : 1590940800000, "custom_feilds" : [ { "key" : "customField15", "name" : "single", "value" : "15Demo" } ], "developer" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "demo" }, "discover_version" : "ProjectMan 8.0.0", "end_time" : 1590940800000, "done_ratio" : 0, "expected_work_hours" : 9, "order" : 1, "parent_issue_id" : 123, "release_version" : "ProjectMan 8.0.0", "root_issue_id" : 0, "story_point" : { "id" : 1, "name" : "0" }, "domain" : { "id" : 14, "name" : "性能" }, "iteration" : { "id" : 456, "name" : "迭代1" }, "module" : { "id" : 456, "name" : "Project" }, "priority" : { "id" : 1, "name" : "低" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "tracker" : { "id" : 7, "name" : "story" }, "subject" : "demo", "updated_time" : 1576114296000 } ], "total" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 issues Array of IssueItemSfV4 objects 工作项信息 total Integer 工作项总数 表5 IssueItemSfV4 参数 参数类型 描述 actual_work_hours Double 实际工时 assigned_user IssueUser object 处理人信息 author IssueUser object 作者信息 begin_time Long 工作项开始时间 closed_time Long 关闭工作项的时间 created_time Long 创建时间 年-月-日 时:分:秒 custom_feilds Array of CustomFeildRecord objects 自定义字段信息 developer IssueUser object 开发人员信息 discover_version String 发现问题的版本 end_time Long 工作项结束时间 年-月-日 时:分:秒 done_ratio Integer 完成度 示例:0 '0%'(输入数字0代表完成度为0%的工作项), 10 '10%', 20 '20%' , 30 '30%', 40 '40%', 50 '50%', 60 '60%', 70 '70%' 80 '80%', 90 '90%', 100 '100%' expected_work_hours Double 预计工时 order Integer 顺序 最小值:1 最大值:100 parent_issue_id Integer 当前工作项的父工作项的id release_version String 发布的版本 root_issue_id Integer 当前工作项对应根节点工作项id story_point story_point object 故事点id (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 分别对应故事点值0, 1/2, 1, 2, 3, 5, 8, 13, 21, 40, 80, 100) domain domain object 领域信息 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' iteration iteration object 迭代信息 module module object 模块信息 priority priority object 优先级,可选值:1 '低',2 '中',3 '高' severity severity object 重要程度, 13 '提示',12 '一般',11'重要',10 '关键' status status object 工作项状态id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6, tracker tracker object 工作项类型, 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story subject String 工作项标题 updated_time Long 工作项更新时间 年-月-日 时:分:秒 表6 CustomFeildRecord 参数 参数类型 描述 key String 自定义字段属性 name String 自定义字段名称 value String 自定义字段值 表7 IssueUser 参数 参数类型 描述 user_id String 用户32位uuid,用户唯一标识 user_num_id Integer 用户数字id, 可通过调用ShowCurUserInfo接口获取当前用户信息 id Integer 用户id name String 用户名 nick_name String 用户昵称 表8 story_point 参数 参数类型 描述 id Integer 故事点id name String 故事点 表9 domain 参数 参数类型 描述 id Integer 领域id, 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' name String 领域, '性能', '功能', '可靠性', '网络安全', '可维护性', '其他DFX' 表10 iteration 参数 参数类型 描述 id Integer 迭代id name String 迭代名 表11 module 参数 参数类型 描述 id Integer 模块id name String 模块 表12 priority 参数 参数类型 描述 id Integer 优先级id, 1 低,2 中, 3高 name String 优先级,低, 中,高 表13 severity 参数 参数类型 描述 id Integer 重要程度id, 13 提示,12 一般, 11 重要, 10 关键 name String 重要程度, 提示,一般, 重要, 关键 表14 status 参数 参数类型 描述 id Integer 状态id, 1 新建, 2 进行中, 3 已解决, 4 测试中, 5 已关闭, 6已拒绝 name String 状态名称, 新建,进行中,已解决,测试中,已关闭,已拒绝 表15 tracker 参数 参数类型 描述 id Integer 工作项类型id 2 任务/Task, 3 缺陷/Bug, 5 Epic, 6 Feature, 7 Story name String 类型名称, 任务/Task, 缺陷/Bug, Epic, Feature, Story 状态码: 400 表16 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表17 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects/{project_id}/issues 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量 从0开始 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0 limit 否 Integer 参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 tracker_id 否 Integer 参数解释: 工作项类型, 约束限制:任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 取值范围:最小值 2 最大值 7 默认取值:不涉及 created_time_interval 否 String 参数解释: 创建工作项的时间(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及 updated_time_interval 否 String 参数解释: 更新工作项的时间(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及
  • 响应示例 状态码: 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 错误码
共100000条