华为云用户手册

  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 bug_statistics Array of BugStatisticResponseV4 objects 参数解释: bug统计信息 表4 BugStatisticResponseV4 参数 参数类型 描述 critical_num Integer 参数解释: 重要程度为关键的缺陷数 取值范围: 不涉及 defect_index Double 参数解释: DI值,不同重要程度的缺陷对应不同的分值 取值范围: 不涉及 module String 参数解释: 模块 取值范围: 不涉及 normal_num Integer 参数解释: 重要程度为一般的缺陷数 取值范围: 不涉及 serious_num Integer 参数解释: 重要程度为严重的缺陷数 取值范围: 不涉及 tip_num Integer 参数解释: 重要程度为提示的缺陷数 取值范围: 不涉及 total Integer 参数解释: 总数 取值范围: 不涉及 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of UpdateChildUserNickNameRequestBody objects 参数解释: 修改的用户列表 约束限制: 不涉及 表3 UpdateChildUserNickNameRequestBody 参数 是否必选 参数类型 描述 nick_name 是 String 参数解释: 用户昵称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_id 是 String 参数解释: 用户id,可从[获取指定项目的成员用户列表]获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及
  • 请求参数 表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( 运维经理) 约束限制: 不涉及 取值范围: -1,3,4,5,6,7,8,9 默认取值: 不涉及 user_ids 是 Array of strings 参数解释: 用户id,通过[获取当前用户信息]接口查询用户对应的租户信息。 约束限制: 正则表达式:[a-zA-Z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及
  • URI POST /v4/projects/{project_id}/members/role 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 响应示例 状态码: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", "deleted" : false } ], "total" : 1 }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 issues Array of ListIssueItemResponse objects 参数解释: 工作项列表 取值范围: 不涉及 total Integer 参数解释: 总数 取值范围: 不涉及 表5 ListIssueItemResponse 参数 参数类型 描述 actual_work_hours Double 参数解释: 实际工时 取值范围: 最小值:0 assigned_cc_user Array of IssueUser objects 参数解释: 抄送人 assigned_user IssueUser object 参数解释: 处理人 begin_time String 参数解释: 预计开始时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 closed_time String 参数解释: 关闭时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 created_time String 参数解释: 创建时间,日期格式:YYYY-MM-DD HH:MM:SS 取值范围: 不涉及 creator IssueUser object 参数解释: 创建人 custom_fields Array of CustomField objects 参数解释: 自定义属性值,不建议使用,建议参考new_custom_fields字段 developer IssueUser object 参数解释: 开发人员 domain domain object 参数解释: 领域 done_ratio Integer 参数解释: 工作项完成度 ,如20,表示完成度为20% 取值范围: 最小值 0 最大值 100 end_time String 参数解释: 预计结束时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 expected_work_hours Double 参数解释: 预计工时 取值范围: 最小值:0 id Integer 参数解释: 工作项id 取值范围: 0至9999999999 iteration iteration object 参数解释: 迭代 module module object 参数解释: 模块 name String 参数解释: 标题 取值范围: 不涉及 new_custom_fields Array of NewCustomField objects 参数解释: 自定义属性值 parent_issue parent_issue object 参数解释: 父工作项 priority priority object 参数解释: 工作项优先级 project IssueProjectResponseV4 object 参数解释: 项目信息 severity severity object 参数解释: 工作项重要程度 status status object 参数解释: 工作项状态 tracker tracker object 参数解释: 工作项类型 updated_time String 参数解释: 更新时间,日期格式:YYYY-MM-DD HH:MM:SS 取值范围: 不涉及 deleted Boolean 参数解释: 是否已经删除,true (已经删除), false (未删除) 取值范围: true,false 表6 IssueUser 参数 参数类型 描述 id Integer 参数解释: 用户id 取值范围: 不涉及 name String 参数解释: 带租户名的用户名(租户名_用户名) 取值范围: 不涉及 nick_name String 参数解释: 昵称 取值范围: 不涉及 user_id String 参数解释: 用户uuid 取值范围: 不涉及 user_num_id Integer 参数解释: 用户数字id 取值范围: 不涉及 first_name String 参数解释: 用户名 取值范围: 不涉及 表7 CustomField 参数 参数类型 描述 name String 参数解释: 自定义属性名 取值范围: 不涉及 new_name String 参数解释: 自定义属性名 取值范围: 不涉及 value String 参数解释: 自定义属性对应的值 取值范围: 不涉及 表8 domain 参数 参数类型 描述 id Integer 参数解释: 领域id,枚举: 14(性能) 15(功能) 16('可靠性) 17(网络安全) 18(可维护性) 19(其他DFX) 20(可用性) 取值范围: 14,15,16,17,18,19,20 name String 参数解释: 领 域名 称 取值范围: 不涉及 表9 iteration 参数 参数类型 描述 id Integer 参数解释: 迭代id 取值范围: 最小值:0 name String 参数解释: 迭代名 取值范围: 不涉及 表10 module 参数 参数类型 描述 id Integer 参数解释: 模块id 取值范围: 最小值:0 name String 参数解释: 模块 取值范围: 不涉及 表11 NewCustomField 参数 参数类型 描述 custom_field String 参数解释: 自定义字段,可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 field_name String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的name值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 value String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的options值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 表12 parent_issue 参数 参数类型 描述 id Integer 参数解释: 父工作项id 取值范围: 最小值:0 name String 参数解释: 父工作项 取值范围: 不涉及 表13 priority 参数 参数类型 描述 id Integer 参数解释: 优先级id,枚举: 1(低) 2(中) 3(高) 取值范围: 1,2,3 name String 参数解释: 优先级 取值范围: 不涉及 表14 IssueProjectResponseV4 参数 参数类型 描述 project_id String 参数解释: 项目id 取值范围: 不涉及 project_name String 参数解释: 项目名称 取值范围: 不涉及 project_num_id Integer 参数解释: 项目数字id 取值范围: 最小值:0 表15 severity 参数 参数类型 描述 id Integer 参数解释: 重要程度id,枚举: 10 (关键) 11 (重要) 12 (一般) 13 (提示) 取值范围: 10,11,12,13 name String 参数解释: 重要程度 取值范围: 不涉及 表16 status 参数 参数类型 描述 id Integer 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 取值范围: 1,2,3,4,5,6 name String 参数解释: 状态名称 取值范围: 不涉及 表17 tracker 参数 参数类型 描述 id Integer 参数解释: 类型id,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 取值范围: 2,3,5,6,7 name String 参数解释: 类型名称 取值范围: 不涉及 状态码:400 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 subject 否 String 参数解释: 工作项标题 约束限制: 正则表达式,[\s\S]{1,200000} 取值范围: 不涉及 默认取值: 不涉及 issue_ids 否 Array of integers 参数解释: 工作项数字id 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 0至9999999999 默认取值: 不涉及 assigned_ids 否 Array of strings 参数解释: 处理人id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 closed_time_interval 否 String 参数解释: 根据工作项的结束时间查询工作项(查询的起始时间,查询的结束时间),unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。 取值范围: 不涉及 默认取值: 不涉及 created_time_interval 否 String 参数解释: 创建工作项的时间(查询的起始时间,查询的结束时间),unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。 取值范围: 不涉及 默认取值: 不涉及 creator_ids 否 Array of strings 参数解释: 创建人id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 custom_fields 否 Array of custom_fields objects 参数解释: 用户自定义字段,可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 developer_ids 否 Array of strings 参数解释: 开发人员id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 domain_ids 否 Array of integers 参数解释: 领域id ,枚举: 14 (性能) 15 (功能) 16 (可靠性) 17 (网络安全) 18 (可维护性) 19 (其他DFX) 20 (可用性) 约束限制: 正则表达式,\d+。 取值范围: 14,15,16,17,18,19,20 默认取值: 不涉及 done_ratios 否 Array of integers 参数解释: 工作项完成度 ,如20,表示完成度为20% 约束限制: 正则表达式:(100|[1-9]?\d)。 取值范围: 最小值 0 最大值 100 默认取值: 不涉及 include_deleted 否 Boolean 参数解释: 查询条件是否包含已删除工作项 约束限制: 正则表达式,(true|false)。 取值范围: true,false 默认取值: 不涉及 iteration_ids 否 Array of integers 参数解释: 迭代id,可通过[获取指定项目的迭代列表]接口获取指定项目的迭代列表 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 limit 否 Integer 参数解释: 每页显示查询高级工作项的数量 约束限制: 不涉及 取值范围: 最小值:1 最大值:100 默认取值: 100 module_ids 否 Array of integers 参数解释: 模块id,通过[查询项目的模块列表]接口获取,响应消息体中的module_id字段的值就是模块id 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 offset 否 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数 约束限制: 正则表达式,0|[1-9]\d{0,10}。 取值范围: 最小值:0 默认取值: 0 priority_ids 否 Array of integers 参数解释: 优先级,枚举: 1(低) 2(中) 3(高) 约束限制: 正则表达式,\d+。 取值范围: 1 , 2 , 3 默认取值: 不涉及 query_type 否 String 参数解释: 查询类型 约束限制: 正则表达式,(epic|feature|backlog|\s*)。 取值范围: backlog(Story|Task|Bug), feature, epic 默认取值: backlog severity_ids 否 Array of integers 参数解释: 重要程度 ,枚举: 10 (关键) 11 (重要) 12 (一般) 13 (提示) 约束限制: 正则表达式,\d+。 取值范围: 10 , 11 , 12 , 13 默认取值: 不涉及 status_ids 否 Array of integers 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 约束限制: 正则表达式,\d+。 取值范围: 1,2,3,4,5,6 默认取值: 不涉及 story_point_ids 否 Array of integers 参数解释: 故事点id, 故事点是一种基于敏捷的估算工作量方法,故事点综合了交付Story所付出的所有努力、开发复杂度、风险,可以简单理解为开发所需要的成本。故事点id对应故事点值: 1(0) 2(1/2) 3(1) 4(2) 5(3) 6(5) 7(8) 8(13) 9(21) 10(40) 11(80) 12(100) 约束限制: 正则表达式,\d+。 取值范围: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 默认取值: 不涉及 tracker_ids 否 Array of integers 参数解释: 工作项类型,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 约束限制: 正则表达式,\d+。 取值范围: 2,3,5,6,7 默认取值: 不涉及 updated_time_interval 否 String 参数解释: 根据工作项的更新时间查询工作项(查询的起始时间,查询的结束时间),unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。 取值范围: 不涉及 默认取值: 不涉及 表3 custom_fields 参数 是否必选 参数类型 描述 custom_field 否 String 参数解释: 自定义字段,可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 value 否 String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的options值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及
  • URI POST /v4/projects/{project_id}/issues 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 响应示例 状态码:200 OK { "total" : 1, "issue_statuses" : [ { "id" : "123cefde62004de2b62b5e8dd2c2b3af", "status_id" : 1, "name" : "新建", "tracker_ids" : [ 0 ], "status_attribute" : { "id" : 1, "name" : "string" } } ] }
  • URI GET /v4/projects/{project_id}/statuses 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数 约束限制: 正则表达式,0|[1-9]\d{0,10}。 取值范围: 最小值:0 默认取值: 0 limit 否 Integer 参数解释: 每页显示查询高级工作项的数量 约束限制: 不涉及 取值范围: 最小值:1 最大值:100 默认取值: 10 tracker_id 否 Integer 参数解释: 工作项类型,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 约束限制: 正则表达式,^\d+。 取值范围: 2,3,5,6,7 默认取值: 不涉及
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 issue_statuses Array of IssueStatus objects 参数解释: 状态列表 total Integer 参数解释: 总数 取值范围: 不涉及 表4 IssueStatus 参数 参数类型 描述 id String 参数解释: 状态uuid 取值范围: 不涉及 name String 参数解释: 状态名称 取值范围: 不涉及 status_attribute StatusAttribute object 参数解释: 状态属性类型 开始态,进行态,结束态 status_id Integer 参数解释: 状态数字id 取值范围: 不涉及 tracker_ids Array of integers 参数解释: 类型id,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 取值范围: 2,3,5,6,7 表5 StatusAttribute 参数 参数类型 描述 id Integer 参数解释: 状态属性id 取值范围: 不涉及 name String 参数解释: 状态属性名称 取值范围: 不涉及 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/members/agc-join 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Domain-Id 是 String 参数解释: 租户ID,通过[获取当前用户信息]接口查询用户对应的租户信息。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及 User-Id 是 String 参数解释: 用户ID,通过[获取当前用户信息]接口查询用户对应的租户信息。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。
  • 响应示例 状态码:200 OK { "actual_work_hours" : 0, "assigned_cc_user" : [ { "id" : 4091, "name" : " demo_user", "nick_name" : "demo" } ], "assigned_user" : { "id" : 4091, "name" : " demo_user", "nick_name" : "demo" }, "begin_time" : "2020-09-12", "created_time" : "2020-09-13 14:40:11", "creator" : { "id" : 4091, "name" : " demo_user", "nick_name" : "demo" }, "custom_fields" : [ { "name" : "customField16", "value" : "select1", "new_name" : "custom_field16" } ], "new_custom_fields" : [ { "custom_field" : "custom_field16", "field_name" : "field_name", "value" : "select1,select2" } ], "developer" : { "id" : 4091, "name" : " demo_user", "nick_name" : "demo" }, "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" : "iteration1" }, "module" : { "id" : 456, "name" : "Project" }, "name" : "issue name", "parent_issue" : { "id" : 123, "name" : "parent issue 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" }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 actual_work_hours Double 参数解释: 实际工时 取值范围: 最小值:0 assigned_cc_user Array of IssueUser objects 参数解释: 抄送人 assigned_user IssueUser object 参数解释: 处理人 begin_time String 参数解释: 预计开始时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 closed_time String 参数解释: 关闭时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 created_time String 参数解释: 创建时间,日期格式:YYYY-MM-DD HH:MM:SS 取值范围: 不涉及 creator IssueUser object 参数解释: 创建人 custom_fields Array of CustomField objects 参数解释: 自定义属性值,不建议使用,建议参考new_custom_fields字段 developer IssueUser object 参数解释: 开发人员 domain domain object 参数解释: 领域 done_ratio Integer 参数解释: 工作项完成度 ,如20,表示完成度为20% 取值范围: 最小值 0 最大值 100 end_time String 参数解释: 预计结束时间,日期格式:YYYY-MM-DD 取值范围: 不涉及 expected_work_hours Double 参数解释: 预计工时 取值范围: 最小值:0 id Integer 参数解释: 工作项id 取值范围: 0至9999999999 iteration iteration object 参数解释: 迭代 module module object 参数解释: 模块 name String 参数解释: 标题 取值范围: 不涉及 new_custom_fields Array of NewCustomField objects 参数解释: 自定义属性值 parent_issue parent_issue object 参数解释: 父工作项 priority priority object 参数解释: 工作项优先级 project IssueProjectResponseV4 object 参数解释: 项目信息 severity severity object 参数解释: 工作项重要程度 status status object 参数解释: 工作项状态 tracker tracker object 参数解释: 工作项类型 updated_time String 参数解释: 更新时间,日期格式:YYYY-MM-DD HH:MM:SS 取值范围: 不涉及 表5 IssueUser 参数 参数类型 描述 id Integer 参数解释: 用户id 取值范围: 不涉及 name String 参数解释: 带租户名的用户名(租户名_用户名) 取值范围: 不涉及 nick_name String 参数解释: 昵称 取值范围: 不涉及 user_id String 参数解释: 用户uuid 取值范围: 不涉及 user_num_id Integer 参数解释: 用户数字id 取值范围: 不涉及 first_name String 参数解释: 用户名 取值范围: 不涉及 表6 CustomField 参数 参数类型 描述 name String 参数解释: 自定义属性名 取值范围: 不涉及 new_name String 参数解释: 自定义属性名 取值范围: 不涉及 value String 参数解释: 自定义属性对应的值 取值范围: 不涉及 表7 domain 参数 参数类型 描述 id Integer 参数解释: 领域id,枚举: 14(性能) 15(功能) 16('可靠性) 17(网络安全) 18(可维护性) 19(其他DFX) 20(可用性) 取值范围: 14,15,16,17,18,19,20 name String 参数解释: 领域名称 取值范围: 不涉及 表8 iteration 参数 参数类型 描述 id Integer 参数解释: 迭代id 取值范围: 最小值:0 name String 参数解释: 迭代名 取值范围: 不涉及 表9 module 参数 参数类型 描述 id Integer 参数解释: 模块id 取值范围: 最小值:0 name String 参数解释: 模块 取值范围: 不涉及 表10 NewCustomField 参数 参数类型 描述 custom_field String 参数解释: 自定义字段,可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 field_name String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的name值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 value String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的options值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 表11 parent_issue 参数 参数类型 描述 id Integer 参数解释: 父工作项id 取值范围: 最小值:0 name String 参数解释: 父工作项 取值范围: 不涉及 表12 priority 参数 参数类型 描述 id Integer 参数解释: 优先级id,枚举: 1(低) 2(中) 3(高) 取值范围: 1,2,3 name String 参数解释: 优先级 取值范围: 不涉及 表13 IssueProjectResponseV4 参数 参数类型 描述 project_id String 参数解释: 项目id 取值范围: 不涉及 project_name String 参数解释: 项目名称 取值范围: 不涉及 project_num_id Integer 参数解释: 项目数字id 取值范围: 最小值:0 表14 severity 参数 参数类型 描述 id Integer 参数解释: 重要程度id,枚举: 10 (关键) 11 (重要) 12 (一般) 13 (提示) 取值范围: 10,11,12,13 name String 参数解释: 重要程度 取值范围: 不涉及 表15 status 参数 参数类型 描述 id Integer 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 取值范围: 1,2,3,4,5,6 name String 参数解释: 状态名称 取值范围: 不涉及 表16 tracker 参数 参数类型 描述 id Integer 参数解释: 类型id,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 取值范围: 2,3,5,6,7 name String 参数解释: 类型名称 取值范围: 不涉及 状态码:400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 actual_work_hours 否 Double 参数解释: 实际工时 约束限制: 不涉及 取值范围: 最小值:0 默认取值: 不涉及 assigned_id 否 Integer 参数解释: 处理人数字id,可通过[获取指定项目的成员用户列表]获取指定项目的成员用户列表,确认特定项目成员的用户数字id。 约束限制: 正则表达式,\d+ 取值范围: 最小值 0 默认取值: 不涉及 begin_time 否 String 参数解释: 开始时间,日期格式:YYYY-MM-DD 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 description 否 String 参数解释: 描述信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 developer_id 否 Integer 参数解释: 开发者id 约束限制: 正则表达式,\d+ 取值范围: 最小值 0 默认取值: 不涉及 domain_id 否 Integer 参数解释: 领域id 约束限制: 正则表达式,\d+ 取值范围: 最小值 0 默认取值: 不涉及 done_ratio 否 Integer 参数解释: 工作项完成度 ,如20,表示完成度为20% 约束限制: 正则表达式:(100|[1-9]?\d)。 取值范围: 最小值 0 最大值 100 默认取值: 不涉及 end_time 否 String 参数解释: 结束时间,日期格式:YYYY-MM-DD 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 expected_work_hours 否 Double 参数解释: 预计工时 约束限制: 不涉及 取值范围: 最小值:0 默认取值: 不涉及 iteration_id 否 Integer 参数解释: 迭代id 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 module_id 否 Integer 参数解释: 模块id 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 name 否 String 参数解释: 标题 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 new_custom_fields 否 Array of NewCustomField objects 参数解释: 用户自定义字段,可以通过[查询Scrum工作项自定义字段]接口获取Scrum工作项自定义字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 parent_issue_id 否 Integer 参数解释: 父工作项的id 约束限制: 正则表达式,\d+。 取值范围: 最小值 0 默认取值: 不涉及 priority_id 否 Integer 参数解释: 优先级,枚举: 1(低) 2(中) 3(高) 约束限制: 正则表达式,\d+。 取值范围: 1 , 2 , 3 默认取值: 不涉及 severity_id 否 Integer 参数解释: 重要程度 ,枚举: 10 (关键) 11 (重要) 12 (一般) 13 (提示) 约束限制: 正则表达式,\d+。 取值范围: 10 , 11 , 12 , 13 默认取值: 不涉及 status_id 否 Integer 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 约束限制: 正则表达式,\d+。 取值范围: 1,2,3,4,5,6 默认取值: 不涉及 tracker_id 否 Integer 参数解释: 工作项类型,枚举: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 约束限制: 正则表达式,\d+。 取值范围: 2,3,5,6,7 默认取值: 不涉及 表3 NewCustomField 参数 是否必选 参数类型 描述 custom_field 否 String 参数解释: 自定义字段,可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 field_name 否 String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的name值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及 value 否 String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过[查询Scrum工作项自定义字段]接口查询Scrum工作项自定义字段中返回的options值获取 约束限制: 可以为空 取值范围: 不涉及 默认取值: 不涉及
  • URI PUT /v4/projects/{project_id}/issues/{issue_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及
  • 响应示例 状态码:200 { "commits" : [ { "repository_id" : "1865706", "branch_name" : "master", "commit_id" : "f608b02311d90f311c41711fdf67003c31305b89", "commit_short_id" : "f608b023", "commit_msg" : "demo", "commit_url" : "https://xxx.xxx/xxxx/commit/791877f7d0e0b2032bc5e38425c1245e804e8741?ref=master", "user" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear" }, "type" : "branch", "create_date" : "2021-11-18 19:47:34", "update_date" : "2021-11-18 19:47:34" } ], "total" : "success" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 commits Array of CommitRecordDetail objects 参数解释: 提交记录列表。 total Integer 参数解释: 总数。 取值范围: 不涉及。 表4 CommitRecordDetail 参数 参数类型 描述 branch_name String 参数解释: 分支名称。 取值范围: 不涉及。 commit_id String 参数解释: commit id。在Git中,每次提交都会生成一个唯一的标识符,称为Commit ID。这个标识符通常是一个40位的SHA-1哈希值,用于唯一标识每一次提交。 取值范围: 不涉及。 commit_msg String 参数解释: commit 信息。每次提交时,开发者需要提供一个描述信息,称为Commit Msg。这个信息用于说明本次提交的具体改动内容,帮助其他开发者理解此次提交的目的和内容。 取值范围: 不涉及。 commit_short_id String 参数解释: commit short id。Commit Short ID是Commit ID的一个简短版本,通常为7位字符长度。它用于简化引用特定提交的操作,同时保持足够的唯一性。 取值范围: 不涉及。 commit_url String 参数解释: commit URL。Commit URL是指指向特定提交的URL链接。通过这个链接,可以直接访问到该提交的详细信息页面,包括提交的作者、时间、改动内容等。 取值范围: 不涉及。 create_date String 参数解释: 创建时间。 取值范围: 不涉及。 repository_id String 参数解释: 仓库ID。在Git中通常指的是用于唯一识别一个仓库的标识符。 取值范围: 不涉及。 type String 参数解释: 查询的类型。 取值范围: 不涉及。 update_date String 参数解释: 更新时间。 取值范围: 不涉及。 user SimpleUser object 参数解释: 用户信息。 表5 SimpleUser 参数 参数类型 描述 nick_name String 参数解释: 用户昵称,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中nick_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_id String 参数解释: 用户uuid,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_name String 参数解释: 账号名,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_num_id Integer 参数解释: 用户数字id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_num_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-commits 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 参数解释: 查询类型。 约束限制: 正则表达式:"commit|branch"。 取值范围: commit(提交记录) branch(分支记录) 默认取值: 不涉及。 limit 是 Integer 参数解释: 条数,每页显示查询的数量。 约束限制: 不涉及。 取值范围: 最小值:1,最大值:1000。 默认取值: 10 offset 是 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数。 约束限制: 从0开始。 取值范围: 最小值:0,最大值:10000。 默认取值: 缺省值:0
  • 请求示例 POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/member { "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "role_id" : 5, "user_id" : "665b542eb4c14b53a15ead449f28b0ba" }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 domain_id 是 String 参数解释: 领域id。可以通过[查询项目的领域列表]接口获取,响应消息体中的domain_id字段的值就是项目领域id。 约束限制: 正则表达式:"[0-9a-z]{32}"。 取值范围: 最大32位。 默认取值: 不涉及。 domain_name 否 String 参数解释: 领域名称,跨租户添加用户时,填写正确的租户名称,可将未授权的租户主动授权,将用户添加为项目成员。 可以通过[查询项目的领域列表]接口获取,响应消息体中的domain_name字段的值就是项目领域名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 role_id 否 Integer 参数解释: 成员角色,用户在项目中的角色ID。 约束限制: 不涉及。 取值范围: -1( 项目创建者) 3(项目经理) 4(开发人员) 5(测试经理) 6(测试人员) 7(参与者) 8(浏览者) 9(运维经理) 默认取值: 不涉及。 user_id 是 String 参数解释: 用户32位uuid。用户通过[获取当前用户信息]接口获取,响应消息体中的user_id字段的值就是用户32位uuid。 约束限制: 正则表达式:"[0-9a-z]{32}"。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI POST /v4/projects/{project_id}/member 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。
  • 响应示例 状态码:200 { "issues" : [ { "subject" : "demo", "issue_id" : 1234, "project" : { "project_name" : "demo", "project_id" : "58d9050550c847c89885c1797a718b0c" }, "user" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear" }, "status" : { "id" : "1", "name" : "未开始" } } ], "total" : 12 }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 issues Array of AssociateIssueDetail objects 参数解释: 关联的工作项列表 total Integer 参数解释: 关联工作项总数 取值范围: 不涉及 表5 AssociateIssueDetail 参数 参数类型 描述 issue_id Integer 参数解释: 工作项ID 取值范围: 不涉及 project SimpleProject object 参数解释: 项目信息 status StatusVo object 参数解释: 工作项状态信息 取值范围: 不涉及 subject String 参数解释: 工作项标题 取值范围: 不涉及 user SimpleUser object 参数解释: 用户信息 表6 SimpleProject 参数 参数类型 描述 project_id String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID 约束限制: 正则表达式,[A-Za-z0-9]{32}。 默认取值: 不涉及 project_name String 参数解释: 项目名称 取值范围: 不涉及 表7 StatusVo 参数 参数类型 描述 id String 参数解释: 状态id 取值范围: 不涉及 name String 参数解释: 状态id对应的值 取值范围: 不涉及 表8 SimpleUser 参数 参数类型 描述 nick_name String 参数解释: 用户昵称,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中nick_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_id String 参数解释: 用户uuid,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_name String 参数解释: 账号名,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_name字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 user_num_id Integer 参数解释: 用户数字id,可通过[获取指定项目的成员用户列表]接口获取指定项目的成员用户列表中user_num_id字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 状态码:400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-issues 表1 路径参数 参数 是否必选 参数类型 描述 issue_id 是 Integer 参数解释: 工作项id,可通过[高级查询工作项]接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 正则表达式,[0-9]{1,10}。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 参数解释: 条数,每页显示查询的数量。 约束限制: 不涉及。 取值范围: 最小值:1,最大值:1000。 默认取值: 10 offset 是 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数。 约束限制: 从0开始。 取值范围: 最小值:0,最大值:10000。 默认取值: 缺省值:0
  • 响应示例 状态码:200 OK { "work_items" : [ { "id" : "4633454879781163008", "description" : "demo", "actual_work_hours" : 10, "assigned_user" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "author" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "begin_time" : "1590940800000", "created_time" : "1590940800000", "tags" : [ { "id" : "456", "name" : "tagdemo" } ], "developer" : { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" }, "assigned_cc_user" : [ { "id" : "665b542eb4c14b53a15ead449f28b0ba", "name" : "demo_user_name", "nick_name" : "demo" } ], "discover_version" : "ProjectMan 8.0.0", "end_time" : "1590940800000", "done_ratio" : "10%", "expected_work_hours" : 9, "order" : "1", "parent_work_item_id" : "4633454879781163001", "release_version" : "ProjectMan 8.0.0", "story_point" : "0", "domain" : { "id" : "14", "name" : "性能" }, "iteration" : { "id" : "456", "name" : "迭代1" }, "module" : { "id" : "456", "name" : "Project" }, "priority" : "低", "severity" : "一般", "status" : { "id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "新建" }, "subject" : "demosubject", "updated_time" : "1595832054113", "sequence" : "5500756", "important" : "提示", "custom_fields" : [ { "field_id" : "d25fe91f7f6b489db5f804e66a0", "field_name" : "customField", "field_type" : "Select", "field_option_source" : "USER", "value" : "{\"id\":\"d25fe91f7f6b489db5f804e66a0\",\"name\":\"devcloud_test001\",\"nick_name\":\"demo\"}" } ] } ], "total" : 1 }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释: 查询看板下工作项总数 取值范围: 不涉及 work_items Array of Workitems objects 参数解释: 工作项信息 表4 Workitems 参数 参数类型 描述 actual_work_hours Double 参数解释: 实际工时 取值范围: 最小值:0 assigned_cc_user Array of WorkitemUser objects 参数解释: 抄送人 assigned_user WorkitemUser object 参数解释: 处理人 author WorkitemUser object 参数解释: 创建人 begin_time String 参数解释: 工作项开始时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 created_time String 参数解释: 创建时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 custom_fields Array of WorkitemCustomField objects 参数解释: 用户自定义字段 description String 参数解释: 工作项描述 取值范围: 不涉及 developer WorkitemUser object 参数解释: 开发人员 discover_version String 参数解释: 发现问题的版本 取值范围: 不涉及 domain domain object 参数解释: 领域 done_ratio String 参数解释: 工作项完成度 ,如20,表示完成度为20% 取值范围: 最小值 0 最大值 100 end_time String 参数解释: 工作项结束时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 expected_work_hours Double 参数解释: 预计工时 取值范围: 最小值:0 id String 参数解释: 工作项id 取值范围: 0至9999999999 important String 参数解释: 重要程度 "关键", "重要", "一般", "提示" 取值范围: 关键,重要,一般,提示 iteration iteration object 参数解释: 迭代 module module object 参数解释: 模块 order String 参数解释: 顺序 取值范围: 不涉及 parent_work_item_id String 父工作项的id 取值范围: 不涉及 priority String 参数解释: 工作项优先级 取值范围: 不涉及 release_version String 参数解释: 发布的版本 取值范围: 不涉及 sequence String 参数解释: 工作项编号 取值范围: 不涉及 severity String 参数解释: 严重的程度 "提示", "一般", "严重", "致命" 取值范围: 提示,一般,严重,致命 status status object 参数解释: 工作项状态 story_point String 参数解释: 故事点 取值范围: 不涉及 subject String 参数解释: 工作项标题 取值范围: 不涉及 tags Array of tags objects 参数解释: 标签 updated_time String 参数解释: 更新时间,unix时间戳,单位:毫秒,样例:1590940800000 取值范围: 不涉及 表5 WorkitemUser 参数 参数类型 描述 id String 参数解释: 用户32位uuid 取值范围: 不涉及 name String 参数解释: 用户名 取值范围: 不涉及 nick_name String 参数解释: 用户昵称 取值范围: 不涉及**** 表6 WorkitemCustomField 参数 参数类型 描述 field_id String 参数解释: 自定义字段id 取值范围: 不涉及 field_name String 参数解释: 自定义字段名称 取值范围: 不涉及 field_option_source String 参数解释: 自定义字段的选项源,枚举: CUSTOM USER DOMAIN ITERATION MODULE TAG 取值范围: CUSTOM,USER,DOMAIN,ITERATION,MODULE,TAG field_type String 参数解释: 自定义字段类型,枚举: Date Number DateTime MultiLineText SingleLineText Select Checkbox 取值范围: Date,Number,DateTime,MultiLineText,SingleLineText,Select,Checkbox value String 参数解释: 自定义字段值 (field_type为Date,Number,DateTime时,field_option_source为空,value值是数字的字符串), (field_type为MultiLineText,SingleLineText时,field_option_source为空,value值是文本字符串), (field_type为Select,field_option_source为CUSTOM时,value值是文本字符串), (field_type为Select ,field_option_source为USER,DOMAIN,ITERATION,MODULE,TAG时,value值是Json格式{}), (field_type为Checkbox ,field_option_source为CUSTOM时,value值是字符串数组["aaa"]), (field_type为"Checkbox",field_option_source为USER,DOMAIN,ITERATION,MODULE,TAG时,value值是Json的数组[{},{}])。 取值范围: 不涉及 表7 domain 参数 参数类型 描述 id String 参数解释: 领域id: 枚举: 14(性能) 15(功能) 16('可靠性) 17(网络安全) 18(可维护性) 19(其他DFX) 20(可用性) 取值范围: 14,15,16,17,18,19,20 name String 参数解释: 领域名称 取值范围: 不涉及 表8 iteration 参数 参数类型 描述 id String 参数解释: 迭代id 取值范围: 最小值:0 name String 参数解释: 迭代名 取值范围: 不涉及 表9 module 参数 参数类型 描述 id String 参数解释: 模块id 取值范围: 最小值:0 name String 参数解释: 模块 取值范围: 不涉及 表10 status 参数 参数类型 描述 id String 参数解释: 状态id,枚举: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) 取值范围: 1,2,3,4,5,6 name String 参数解释: 状态名称 取值范围: 不涉及 表11 tags 参数 参数类型 描述 id String 参数解释: 标签id 取值范围: 不涉及 name String 参数解释: 标签名称 取值范围: 不涉及 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v4/projects/{project_id}/work-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释: 分页索引,偏移量,offset是limit的整数倍数 约束限制: 正则表达式,0|[1-9]\d{0,10}。 取值范围: 最小值:0 默认取值: 0 limit 否 Integer 参数解释: 每页显示查询看板下工作项的数量 约束限制: 不涉及 取值范围: 最小值:1 最大值:100 默认取值: 100 created_time_interval 否 String 参数解释: 根据工作项的创建时间查询工作项(查询的起始时间,查询的结束时间),unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?。 取值范围: 不涉及 默认取值: 不涉及
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 templates Array of templates objects 参数解释: 模板信息列表。 表5 templates 参数 参数类型 描述 id Integer 参数解释: 模板id。 取值范围: 不涉及。 project_id Integer 参数解释: 项目id。 取值范围: 不涉及。 tracker_id Integer 参数解释: 工作项类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) description String 参数解释: 工作项详情模板描述内容。 取值范围: 最小长度:0,最大长度:65535。 issue_field_config String 参数解释: 模板配置。 取值范围: 不涉及。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全