华为云用户手册

  • 响应示例 状态码: 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 表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 表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时查询项目中所有自定义字段
  • 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 PM.02150010 目标用户非项目空间成员 目标用户非项目空间成员 将需要的用户先添加到项目空间 400 PM.02150301 删除失败, 删除失败, 将是这个角色的用户先修改成其他的角色,再删除 400 PM.02150302 所设置权限不可变更 所设置权限不可变更 所设置权限不可变更 400 PM.02150303 角色不存在 角色不存在 核实请求参数 400 PM.02150304 角色名不可用,请设置新名称 角色名不可用,请设置新名称 请设置新名称 400 PM.02150305 角色名冲突 角色名冲突 请设置新名称 400 PM.02150404 项目空间不存在 项目空间不存在 项目空间不存在 400 PM.02151001 项目集不存在 项目集不存在 项目集不存在 400 PM.02152001 参数错误 参数错误 参数错误 400 PM.02152002 未定义错误 未定义错误 未定义错误 400 PM.02152003 传入参数名非法 传入参数名非法 传入参数名非法 400 PM.02152004 项目集未归档 项目集未归档 项目集未归档 400 PM.02152005 项目不存在或项目已被删除 项目不存在或项目已被删除 项目不存在或项目已被删除 400 PM.02152006 该项目集还没有被关注 该项目集还没有被关注 该项目集还没有被关注 400 PM.02152007 已关注该项目集 已关注该项目集 已关注该项目集 400 PM.02152008 修改创建项目集权限的参数含有非法用户 修改创建项目集权限的参数含有非法用户 修改创建项目集权限的参数含有非法用户 400 PM.02152009 项目集已归档 项目集已归档 项目集已归档 400 PM.02152010 项目类型不被允许 项目类型不被允许 项目类型不被允许 400 PM.02152011 项目已被关联 项目已被关联 项目已被关联 400 PM.02153001 访问频率过高,请稍后再试 访问频率过高,请稍后再试 访问频率过高,请稍后再试 400 PM.02175006 CN: 参数错误: {0}; EN: Invalid Parameter: {0} 参数错误 使用正确的请求参数重试 400 PM.02175101 CN: 子节点数量超过限制:{0}; Number of sub items exceeds [{0}] 子节点数量不能超过限制 删除其他子节点后再创建,或者在其他父节点下创建 400 PM.02175103 CN: 无法修改未被接纳或已拒绝的IR; EN: Only accepted initial requirement can be edited 当前IR无法被修改(只有当提出项目空间与归属项目空间相同,或者在归属项目空间被接纳的IR才能被修改。修改IR或者在父IR下创建子项时可能发生此错误) 确认修改的IR的状态后重试 400 PM.02175104 CN: 所选IR无法操作; EN: Some of the initial requirements can not be edited 部分IR无法修改(通常是因为部分请求的IR不存在) 确认所有修改的IR都存在后重试 400 PM.02175105 CN: 无效的父IR; EN: Invalid parent. 无效的父IR(此错误发生于批量创建子IR时,父IR不一致,或者父IR的归属项目空间与子IR的提出项目空间不一致,或者指定的父IR类型不正确) 使用正确的请求参数重试 400 PM.02175106 CN: 子IR必须提给其他项目空间; EN: Can not create sub ir to current program. 子IR的提出项目空间与归属项目空间不能相同 将子IR提给其他项目空间 400 PM.02175111 CN: 当前IR下有子IR,不能删除; EN: Child IR exist, can not delete. 不能删除具有子IR的父IR 删除所有子IR后再删除父IR 400 PM.02175113 CN: 父IR不存在; EN: Parent IR not exists. 父IR不存在 在正确的父IR下创建子IR 400 PM.02175114 CN: 父IR不归属于当前项目空间,请到父IR的归属项目空间进行操作; EN: Parent IR not designated in current program, please perform in the destination program of this IR. 父IR不归属于当前项目空间 到父IR的归属项目空间中重试 400 PM.02175115 CN: 不能删除IR:不具有所有子工作项所在项目的编辑权限; EN: Missing edit permission of sub items. 不能删除IR,因为不具有所有子工作项所在项目的编辑权限 申请子工作项所在项目的编辑权限后重试 400 PM.02175200 CN: 缺少必填字段 [{0}]; EN: Missing required field [{0}] 缺少必填字段 添加必填字段后重试 400 PM.02175201 CN: 字段 [{0}] 的值不正确{1}; EN: Field [{0}] has invalid value{1} IR字段的值不正确(无具体原因是,通常是格式错误,比如时间/日期字段使用了非时间戳字符串) 使用正确的值进行请求 400 PM.02175202 CN: 预计开始日期不能晚于预计结束日期; EN: Plan start date can not be later than plan due date. 预计开始日期不能晚于预计结束日期 使用正确的预计开始日期/预计结束日期参数 400 PM.10001002 不合法的token 不合法的token 不合法的token 400 PM.10002006 当前租户下名称已被使用 当前租户下名称已被使用 当前租户下名称已被使用 400 PM.10002010 描述不超过500个字符 描述不超过500个字符 描述不超过500个字符 400 PM.10002011 名称不规范 名称不规范 名称不规范 400 PM.10003002 当前用户权限不足 当前用户权限不足 当前用户权限不足 400 PM.10003003 邀请已过期 邀请已过期 邀请已过期 400 PM.10003004 审核信息不存在 审核信息不存在 审核信息不存在 400 PM.10003005 标签在使用中 标签在使用中 标签在使用中 400 PM.10003006 添加成员最多不超过100个 添加成员最多不超过100个 添加成员最多不超过100个 400 PM.10003007 最多可以添加100个项目 最多可以添加100个项目 最多可以添加100个项目 400 PM.10003008 角色不被允许 角色不被允许 角色不被允许 400 PM.10003009 创建者移交项目空间后可以退出项目 创建者移交项目空间后可以退出项目 创建者移交项目空间后可以退出项目 400 PM.10003010 成员已不存在 成员已不存在 成员已不存在 400 PM.10003011 租户下项目空间总数不能超过100个 租户下项目空间总数不能超过100个 租户下项目空间总数不能超过100个 400 PM.10003014 邀请不存在 邀请不存在 邀请不存在 400 PM.10003015 只能添加同租户下用户 只能添加同租户下用户 只能添加同租户下用户 400 PM.10003016 添加成员失败 添加成员失败 添加成员失败 401 PM.02150401 用户操作权限不足 用户操作权限不足 用户操作权限不足 403 PM.10003012 用户是项目空间成员,不需要申请 用户是项目空间成员,不需要申请 用户是项目空间成员,不需要申请 404 PM.02175005 CN: 当前请求资源不存在; EN: Requested resource not exist 查询的资源不存在 确认请求的资源是否存在(可能输入了错误的id,或资源已被删除) 405 PM.10003013 已存在加入项目空间的申请,等待管理员审批 已存在加入项目空间的申请,等待管理员审批 已存在加入项目空间的申请,等待管理员审批
  • 响应参数 状态码: 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 用户uuid user_name String 账号名 nick_name String 用户昵称 表8 SimpleProject 参数 参数类型 描述 project_name String 项目名称 project_id String 项目id 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associate-test-cases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 issue_id 是 Integer 工作项ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页数量 offset 否 Integer 偏移量
  • 响应示例 状态码: 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}/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 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"}
  • 请求示例 POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/system/issue{ "parent_issue_id" : 1679822, "end_time" : "2018-07-05", "name" : "test", "begin_time" : "2018-1-31", "description" : "", "assigned_id" : 4091, "developer_id" : 4091, "tracker_id" : 3, "status_id" : 1, "priority_id" : 2, "severity_id" : 10, "iteration_id" : 11302238, "creator" : { "user_id" : "a360371833bf4c558f796fd707b44daf" }}
  • 响应示例 状态码: 200 OK { "actual_work_hours" : 0, "assigned_cc_user" : [ { "id" : 4091, "name" : "demo_user_name", "nick_name" : "bear" } ], "assigned_user" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "bear" }, "begin_time" : "2020-09-12", "creator" : { "id" : 4091, "name" : "demo_user_name", "nick_name" : "bear" }, "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" : "bear1" }, "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" }, "parent_issue" : { "id" : 123, "name" : "parentIssue" }, "priority" : { "id" : 1, "name" : "低" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "tracker" : { "id" : 7, "name" : "story" }}
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 actual_work_hours Double 实际工时 assigned_cc_user Array of IssueUser objects 抄送人 assigned_user IssueUser object begin_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 模块 parent_issue parent_issue object 父工作项 priority priority object 工作项优先级 severity severity object 工作项重要程度 status status object 工作项状态 tracker tracker object 工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story 表8 IssueUser 参数 参数类型 描述 user_id String 用户uuid user_num_id Integer 用户数字id id Integer 用户id name String 用户名 nick_name String 昵称 表9 CustomField 参数 参数类型 描述 name String 自定义属性名 value String 自定义属性对应的值 new_name String 自定义属性名 表10 NewCustomField 参数 参数类型 描述 custom_field String 自定义字段 field_name String 自定义字段名称 value String 自定义属性对应的值,多个值以英文逗号区分开 表11 domain 参数 参数类型 描述 id Integer 领域id name String 领域 表12 IssueProjectResponseV4 参数 参数类型 描述 project_id String 项目id project_name String 项目名称 project_num_id Integer 项目数字id 表13 iteration 参数 参数类型 描述 id Integer 迭代id name String 迭代名 表14 module 参数 参数类型 描述 id Integer 模块id name String 模块 表15 parent_issue 参数 参数类型 描述 id Integer 父工作项id name String 父工作项 表16 priority 参数 参数类型 描述 id Integer 优先级id name String 优先级 表17 severity 参数 参数类型 描述 id Integer 重要程度id name String 重要程度 表18 status 参数 参数类型 描述 id Integer 状态id name String 状态名称 表19 tracker 参数 参数类型 描述 id Integer 类型id name String 类型名称 状态码: 400 表20 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表21 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表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 { "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 参数 参数类型 描述 subject String 工作项标题 issue_id Integer 工作项ID project SimpleProject object user SimpleUser object status StatusVo object 状态 表6 SimpleProject 参数 参数类型 描述 project_name String 项目名称 project_id String 项目id 表7 SimpleUser 参数 参数类型 描述 user_num_id Integer 用户数字id user_id String 用户uuid user_name String 账号名 nick_name String 用户昵称 表8 StatusVo 参数 参数类型 描述 id String 状态id name String 状态id对应的值 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects/{project_id}/issues/{issue_id}/associated-issues 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 issue_id 是 Integer 工作项ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页数量 offset 否 Integer 偏移量
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 - File 二进制文件 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 OK { "actual_work_hours" : 0, "assigned_cc_user" : [ { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" } ], "assigned_user" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" }, "begin_time" : "2020-09-12", "creator" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" }, "custom_fields" : [ { "name" : "customField16", "value" : "多选框", "new_name" : "custom_field16" } ], "new_custom_fields" : [ { "custom_field" : "custom_field16", "field_name" : "field_name", "value" : "select1,select2" } ], "developer" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "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" : "iteration_1" }, "module" : { "id" : 456, "name" : "Project" }, "parent_issue" : { "id" : 123, "name" : "paren_issue_demo" }, "priority" : { "id" : 1, "name" : "低" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "tracker" : { "id" : 7, "name" : "story" }}
  • 请求示例 POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issue{ "parent_issue_id" : 1679822, "end_time" : "2018-07-05", "name" : "test", "begin_time" : "2018-1-31", "description" : "", "assigned_id" : 4091, "developer_id" : 4091, "tracker_id" : 3, "status_id" : 1, "priority_id" : 2, "severity_id" : 10, "iteration_id" : 11302238}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 actual_work_hours Double 实际工时 assigned_cc_user Array of IssueUser objects 抄送人 assigned_user IssueUser object begin_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 模块 parent_issue parent_issue object 父工作项 priority priority object 工作项优先级 severity severity object 工作项重要程度 status status object 工作项状态 tracker tracker object 工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story 表6 IssueUser 参数 参数类型 描述 user_id String 用户uuid user_num_id Integer 用户数字id id Integer 用户id name String 用户名 nick_name String 昵称 表7 CustomField 参数 参数类型 描述 name String 自定义属性名 value String 自定义属性对应的值 new_name String 自定义属性名 表8 NewCustomField 参数 参数类型 描述 custom_field String 自定义字段 field_name String 自定义字段名称 value String 自定义属性对应的值,多个值以英文逗号区分开 表9 domain 参数 参数类型 描述 id Integer 领域id name String 领域 表10 IssueProjectResponseV4 参数 参数类型 描述 project_id String 项目id project_name String 项目名称 project_num_id Integer 项目数字id 表11 iteration 参数 参数类型 描述 id Integer 迭代id name String 迭代名 表12 module 参数 参数类型 描述 id Integer 模块id name String 模块 表13 parent_issue 参数 参数类型 描述 id Integer 父工作项id name String 父工作项 表14 priority 参数 参数类型 描述 id Integer 优先级id name String 优先级 表15 severity 参数 参数类型 描述 id Integer 重要程度id name String 重要程度 表16 status 参数 参数类型 描述 id Integer 状态id name String 状态名称 表17 tracker 参数 参数类型 描述 id Integer 类型id name String 类型名称 状态码: 400 表18 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表19 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表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 用户自定义字段 表4 NewCustomField 参数 是否必选 参数类型 描述 custom_field 否 String 自定义字段 field_name 否 String 自定义字段名称 value 否 String 自定义属性对应的值,多个值以英文逗号区分开
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 - File 二进制文件 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 project_num_id Integer 项目数字id project_id String 项目id 最小长度:32 最大长度:32 project_name String 项目名 最小长度:1 最大长度:128 description String 项目描述 project_type String 项目类型 user_num_id Integer 创建者的数字id 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 表2 请求Body参数 参数 是否必选 参数类型 描述 project_name 是 String 项目名称 最小长度:1 最大长度:128 description 否 String 项目描述 source 否 String 项目来源 project_type 是 String 项目类型 scrum, xboard(看板项目), basic, phoenix(凤凰项目) enterprise_id 否 String 项目要绑定的企业项目ID template_id 否 Integer 用户创建的项目模板id
  • 响应示例 状态码: 200 OK { "project_num_id" : 708168641, "project_name" : "testdemo", "project_id" : "2e76d6f0b2c5403796e36bf63c5d5561", "user_num_id" : 700145037, "project_type" : "scrum", "description" : "this is demo"} 状态码: 400 Bad Request { "error_msg" : "param error", "error_code" : "PM.00000001"}
  • 请求示例 DELETE https://{endpoint}/v4/projects/f7a67aee4c034fd6944fd5f769e89042/issues/5667740/attachments/72372DELETE https://{endpoint}/v4/projects/f7a67aee4c034fd6944fd5f769e89042/issues/5667740/attachments/72372
共100000条