华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 actual_work_hours 否 Double 实际工时 assigned_id 否 Integer 处理人id,对应用户信息的数字id begin_time 否 String 开始时间,年-月-日 description 否 String 描述信息 developer_id 否 Integer 开发者id,对应用户信息的数字id domain_id 否 Integer id 领域, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性' done_ratio 否 Integer 工作项进度值 end_time 否 String 结束时间,年-月-日 expected_work_hours 否 Double 预计工时 iteration_id 否 Integer 迭代id module_id 否 Integer 模块id name 是 String 标题 parent_issue_id 否 Integer 父工作项的id,创建子工作项时必填,父工作项的类型tracker_id不能为2,3 priority_id 是 Integer 优先级, 1 低, 2 中, 3 高, severity_id 否 Integer 重要程度, 10 关键, 11 重要, 12 一般, 13 提示, status_id 否 Integer 状态 id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6, tracker_id 是 Integer 工作项类型, 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 5 只能为 6 的父工作项类型; 6 只能为 7 的父工作项类型; 7 只能为 2,3的父; new_custom_fields 否 Array of NewCustomField objects 用户自定义字段 creator 是 Creator object 创建者 custom_fields 否 Array of ScrumCustomField objects 用户自定义字段 表4 NewCustomField 参数 是否必选 参数类型 描述 custom_field 否 String 自定义字段 field_name 否 String 自定义字段名称 value 否 String 自定义属性对应的值,多个值以英文逗号区分开 表5 Creator 参数 是否必选 参数类型 描述 user_id 是 String 指定工作项的创建者用户id 表6 ScrumCustomField 参数 是否必选 参数类型 描述 name 否 String 自定义字段 value 否 String 自定义字段值
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 test_cases Array of AssociatedTestCase objects 关联的测试用例列表 total Integer 关联的测试用例总数 表5 AssociatedTestCase 参数 参数类型 描述 case_id String 用例ID case_num String 用例编号 case_name String 用例名称 case_level String 用例等级 status StatusVo object 状态 creator SimpleUser object 创新者信息 owner SimpleUser object 用例归属人信息 project SimpleProject object 项目信息 is_base_line Integer 是否基线 type String 用例类型 created_time Long 创建时间 表6 StatusVo 参数 参数类型 描述 id String 状态id name String 状态id对应的值 表7 SimpleUser 参数 参数类型 描述 user_num_id Integer 用户数字id user_id String 用户32位uuid,用户唯一标识 user_name String 用户名 nick_name String 用户昵称 表8 SimpleProject 参数 参数类型 描述 project_name String 项目名称 project_id String 项目32位uuid,项目唯一标识 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表10 响应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}
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associate-test-cases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 issue_id 是 Integer 参数解释:工作项id,可通过ListIssuesV4接口高级查询工作项 约束限制:正则表达式,[0-9]{1,10}$ 取值范围:最小长度:1,最大长度:10 默认取值:不涉及 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 offset 否 Integer 参数解释:偏移量 从0开始 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-wikis 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 issue_id 是 Integer 工作项ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页数量 offset 否 Integer 偏移量
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 wikis Array of AttachWikiDetail objects 关联的wiki列表 total Integer 总数 表5 AttachWikiDetail 参数 参数类型 描述 issue_id Integer 工作项ID wiki_title String Wiki标题 wiki_author SimpleUser object wiki创建者 project SimpleProject object 项目 created_date String 创建时间 wiki_id String wiki ID region String region值 表6 SimpleUser 参数 参数类型 描述 user_num_id Integer 用户数字id user_id String 用户uuid user_name String 账号名 nick_name String 用户昵称 表7 SimpleProject 参数 参数类型 描述 project_name String 项目名称 project_id String 项目id 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 { "wikis" : [ { "issue_id" : 1234, "wiki_title" : "wikidemo", "wiki_author" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "demo" }, "project" : { "project_name" : "demo", "project_id" : "58d9050550c847c89885c1797a718b0c" }, "created_date" : "2021-11-18 19:47:34", "wiki_id" : "1839097", "region" : "cn-north-xxx" } ], "total" : "success"}
  • 响应示例 状态码: 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 选项顺序
  • 响应参数 状态码: 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 错误码
  • 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 { "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}
  • 响应示例 状态码: 200 OK { "status" : "success", "result" : { "data" : [ { "id" : "1017841308053581824", "number" : "CR20240710077151", "state" : "正在工作", "title" : "111", "category" : "CR", "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试昵称" }, "modified_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试昵称" }, "created_time" : "1720601878000", "modified_time" : "1720601878000", "need_approval" : "yes", "status" : { "display_value" : "待评审", "code" : "ToBeReviewed" } } ], "total" : 1 }}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求错误信息 result ReviewListResult object 评审单列表 表6 ReviewListResult 参数 参数类型 描述 data Array of ReviewEntity objects 评审单列表 total Integer 项目下评审单总数。CR/BR/GR互不干扰 表7 ReviewEntity 参数 参数类型 描述 id String 评审单id number String 评审单编号 state String 评审单工作状态,取值为"正在工作","作废" title String 评审单标题 category String 评审单类别,CR:变更评审,BR:基线评审,GR:通用评审 created_by UserEntity object 评审单创建人 modified_by UserEntity object 评审单最后修改人 assigned_cc Array of UserEntity objects 评审单抄送人 created_time String 评审单创建时间戳 modified_time String 评审单最后修改时间戳 plan_end_date String 计划完成日期时间戳,不可早于计划开始日期 plan_start_date String 计划开始日期时间戳,不可晚于计划完成日期 close_time String 评审单完成时间 need_approval String 评审单是否需要审批人审批,可选值为yes,no status StatusEntity object 评审单状态 description String 评审单描述,列表接口不返回描述信息 cos Array of COEntity objects 评审对象列表 ccbs Array of CcbEntity objects 审批信息列表 表8 StatusEntity 参数 参数类型 描述 id String 状态id belonging String 工作项的状态属性,START、IN_PROGRESS、END display_value String 状态名 code String 状态唯一标识 created_by String 状态创建人 created_time String 状态创建时间 modified_by String 状态修改人 modified_time String 状态最近修改时间 category_code Array of strings 状态被哪些工作项使用 表9 COEntity 参数 参数类型 描述 after_change String 变更对象修改后内容 review_complete_time String 变更对象评审完成时间 review_phase_result String 变更对象评审阶段结果 Approved:通过 Rejected:拒绝(CR) TurnBacked:驳回(BR/GR) review_time String 变更对象评审时间 approver Array of strings 变更对象审批人ID数组 before_change String 变更对象工作项修改前内容 category String 变更对象工作项类型,此处固定为CO ccb_info CcbEntity object 变更对象实际审批人信息 ccbs Array of UserEntity objects 变更对象审批人列表,兼容旧版评审。现版本审批人只有一人 change_type String 变更类型,基线评审的修改类型属于Modify Modify:修改 Move:迁移 Delete:删除 co2review String 变更对象关联的评审单Id created_by String 变更对象的创建人ID created_date String 变更对象创建时间 description String 变更对象描述信息 id String 变更对象Id issue_id String 变更对象关联的工作项Id issue_number String 变更对象关联的工作项编号 modified_by String 变更对象最后修改人Id modified_date String 变更对象最后修改时间 opinion_comments Array of ReviewOpinionEntity objects 变更对象评审意见 reviewer Array of strings 变更对象评审专家Id列表 status String 变更对象状态 表10 CcbEntity 参数 参数类型 描述 approval_time String 审批时间 category String 工作项类型,审批对象固定为CCB ccb2review String 审批对象关联的评审单Id co_id String 关联的变更对象Id id String 审批对象Id owner UserEntity object 审批人 approval_comments String 审批意见 表11 UserEntity 参数 参数类型 描述 id String 用户Id name String 用户名称 nick_name String 用户昵称 表12 ReviewOpinionEntity 参数 参数类型 描述 category String 评审意见对象类型,固定为Opinion co_id String 评审意见对象关联的变更对象Id created_by UserEntity object 评审意见创建人,即评审人 created_date String 评审意见创建时间 curr_owner UserEntity object 当前评审人 id String 评审意见对象Id modified_date String 评审意见最后修改时间 review_comments String 评审意见
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 评审单类型,可选值为CR,BR,GR created_by 否 String 评审单创建人Id keyword 否 String 关键字搜索,标题支持模糊搜索,编号支持精确搜索 created_time 否 DateFilterVO object 评审单创建时间过滤器 plan_end_date 否 DateFilterVO object 评审单计划完成时间过滤器 plan_start_date 否 DateFilterVO object 评审单计划开始时间过滤器 closed_time 否 DateFilterVO object 评审单完成时间过滤器 approver 否 String 按评审单审批人Id过滤,多值使用英文逗号分隔 reviewer 否 String 按评审单评审专家Id过滤,多值使用英文逗号分隔 offset 否 Integer 分页参数起始偏移量。默认值为0,需要可以整除limit limit 否 Integer 分页参数每页大小。默认值为20,需要可以被offset整除,不能为0,否则会指定为默认值 sort 否 Array of SortInfo objects 排序方式 表3 DateFilterVO 参数 是否必选 参数类型 描述 start_date 否 String 时间过滤器开始时间戳,-2表示未设置内容 end_date 否 String 时间过滤器结束时间戳,-2表示未设置内容 表4 SortInfo 参数 是否必选 参数类型 描述 field 否 String 排序字段 asc 否 Boolean 是否升序
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 commits Array of CommitRecordDetail objects 提交记录列表 total Integer 提交记录总数 表5 CommitRecordDetail 参数 参数类型 描述 repository_id String 仓库ID branch_name String 分支名称 commit_id String commit id commit_short_id String commit short id commit_msg String commit 信息 commit_url String commit URL user SimpleUser object 用户信息 type String 查询的类型 create_date String 创建时间 update_date String 更新时间 表6 SimpleUser 参数 参数类型 描述 user_num_id Integer 用户数字id user_id String 用户32位uuid,用户唯一标识 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 { "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"}
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-commits 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 issue_id 是 Integer 参数解释:工作项id,可通过ListIssuesV4接口高级查询工作项 约束限制:正则表达式,[0-9]{1,10}$ 取值范围:最小长度:1,最大长度:10 默认取值:不涉及 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 参数解释:查询类型: 约束限制:正则表达式, ^(commit|branch)$ 取值范围:commit(提交记录) || branch(分支记录) 默认取值:不涉及 limit 否 Integer 参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 offset 否 Integer 参数解释:偏移量 从0开始 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0
  • 响应示例 状态码: 200 OK { "dividend_value" : 15, "divisor_value" : 20, "metric_name" : "completion_rate|bug_density|bugs_per_developer", "metric_value" : 0.8945, "project_id" : "eace9c0a00574de6878ab580daa9a317", "project_name" : "我的项目"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 date_range 否 String 统计周期 metric_type 否 String 指标类型 sprint_id 否 String 迭代ID dividend 否 dividend object 指标分子过滤条件 divisor 否 Object 指标分母过滤条件 表4 dividend 参数 是否必选 参数类型 描述 on_time 否 String 是否按时 custom_field16 否 String 自定义字段 custom_field17 否 String 自定义字段 custom_field18 否 String 自定义字段 custom_field19 否 String 自定义字段 custom_field20 否 String 自定义字段 custom_field21 否 String 自定义字段 custom_field22 否 String 自定义字段 custom_field23 否 String 自定义字段 custom_field24 否 String 自定义字段 custom_field25 否 String 自定义字段 custom_field26 否 String 自定义字段 custom_field27 否 String 自定义字段 custom_field28 否 String 自定义字段 custom_field29 否 String 自定义字段 custom_field30 否 String 自定义字段 custom_field31 否 String 自定义字段 custom_field32 否 String 自定义字段 custom_field33 否 String 自定义字段 custom_field34 否 String 自定义字段 custom_field35 否 String 自定义字段 custom_field36 否 String 自定义字段 custom_field37 否 String 自定义字段 custom_field38 否 String 自定义字段 custom_field39 否 String 自定义字段 custom_field40 否 String 自定义字段
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 dividend_value String 指标分子数值 divisor_value String 指标分母数值 metric_name String 指标名称 metric_value String 指标数值 project_id String 项目ID project_name String 项目名称 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求示例 Post https://{endpoint}/v1/eace9c0a00574de6878ab580daa9a317/completion-rate/query{ "date_range" : "1598457600000,1598544000000", "dividend" : { "custom_field16" : "自定义字段值", "on_time" : "ontime" }, "divisor" : { }, "metric_type" : "on-time_completion_rate", "sprint_id" : "8883443"}
  • 响应示例 状态码: 200 OK { "projects" : [ { "project_num_id" : 3183801, "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8", "project_name" : "demo_project", "description" : "demo", "created_time" : 1576114296000, "updated_time" : 1576114296000, "project_type" : "xboard", "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" : 10}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 projects Array of projects objects 项目信息列表 数组长度:0 - 100 total Integer 项目总数 最小值:0 最大值:10000 表4 projects 参数 参数类型 描述 project_num_id Integer 项目numId project_id String 项目uuid project_name String 项目名称 description String 项目描述 created_time Long 项目创建时间 updated_time Long 项目更新时间 project_type String 项目类型 creator creator object 创建者信息 表5 creator 参数 参数类型 描述 user_num_id Integer 创建人numId user_id String 创建人id 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 错误码 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects 表1 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移量 从0开始 最小值:0 最大值:10000 缺省值:0 limit 是 Integer 条数 最小1条,最大1000 最小值:1 最大值:1000 缺省值:10 search 否 String 模糊查询项目名称或描述,不支持通配符等高级查询 project_type 否 String 项目类型 scrum|xboard sort 否 String 排序条件 默认创建时间降序(name|created_on)(asc|desc) archive 否 String 是否归档 true已归档|false未归档 query_type 否 String 默认返回当前用户参与的项目列表,domain_projects租户下的所有项目列表,absent返回当前用户未参与的租户项目列表
  • 响应参数 状态码: 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 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}
共99354条