华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 custom_fields 否 Array of strings 自定义字段 names 否 Array of strings 自定义字段页面显示的含义 included_not_in_use 否 Boolean 查询结果是否包括未使用的自定义字段,默认仅查询使用中的自定义字段,设为true时查询项目中所有自定义字段
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 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" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 projects Array of projects objects 项目信息列表 数组长度:0 - 1000 total Integer 总数 最小值:0 最大值:10000 表4 projects 参数 参数类型 描述 project_num_id Integer 项目数字id project_id String 项目id 最小长度:32 最大长度:32 project_name String 项目名 最小长度:1 最大长度:128 description String 项目描述 created_time Long 项目创建时间 最小长度:0 最大长度:13 updated_time Long 项目更新时间 最小长度:0 最大长度:13 project_type String 项目类型 creator creator object 创建者信息 表5 creator 参数 参数类型 描述 user_num_id Integer 创建人numId user_id String 创建人id 最小长度:1 最大长度:32 user_name String 创建人姓名 domain_id String 创建人租户id 最小长度:1 最大长度:32 domain_name String 创建人租户名称 nick_name String 创建人租户昵称 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 OK { "projects" : [ { "project_num_id" : 3056544, "project_id" : "e2da96a5d2c845e284f0ad47f8ca8cb1", "project_name" : "demo_project", "description" : "这是一个demo", "created_time" : "1571296951000", "updated_time" : "1571296951000", "project_type" : "scrum", "creator" : { "user_num_id" : 4097, "user_id" : "c4bd39f0573a436589714bedbcca8536", "user_name" : "modile_user", "domain_id" : "2489d8cbba804db8bcd35384685ff3ac", "domain_name" : "modile_user", "nick_name" : "Tom.M.Riddle" } } ], "total" : 1 }
  • URI GET /v4/projects/domain/not-added 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引,偏移量,offset是limit的整数倍,limit=10,offset=0,10,20... 最小值:0 缺省值:0 limit 否 Integer 每页显示的数量,每页最多显示100条 最小值:1 最大值:100 缺省值:10
  • 响应示例 状态码: 200 ok { "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 }
  • 响应参数 状态码: 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 错误码
  • 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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 - File 二进制文件 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 - File 二进制文件 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求示例 DELETE https://{endpoint}/v4/projects/f7a67aee4c034fd6944fd5f769e89042/issues/5667740/attachments/72372 DELETE https://{endpoint}/v4/projects/f7a67aee4c034fd6944fd5f769e89042/issues/5667740/attachments/72372
  • 请求参数 表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" }
  • 响应参数 状态码: 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 错误码
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 domain_name String 领 域名 称 domain_id String 领域id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 id Integer 迭代id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI POST /v4/projects/{project_id}/iteration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 begin_time 是 String 参数解释:开始时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 description 否 String 参数解释:迭代的描述 约束限制:可以为空 取值范围:最小长度:0 最大长度:500 默认取值:不涉及 end_time 是 String 参数解释:结束时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 name 是 String 参数解释:标题 约束限制:不涉及 取值范围:最小长度:1 最大长度:255 默认取值:不涉及
  • 响应示例 状态码: 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 工作项优先级,1 '低',2 '中',3 '高' severity severity object 工作项重要程度 status status object 工作项状态 tracker tracker object 工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story 表6 IssueUser 参数 参数类型 描述 user_id String 用户32位uuid,用户唯一标识,需要通过IAM获取 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,14 '性能', 15 '功能', 16 '可靠性', 17 '网络安全', 18 '可维护性', 19 '其他DFX', 20 '可用性', name String 领域, '性能', '功能', '可靠性', '网络安全', '可维护性', '其他DFX', '可用性', 表10 IssueProjectResponseV4 参数 参数类型 描述 project_id String 项目32位uuid,项目唯一标识 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,1 '低',2 '中',3 '高' name String 优先级,'低','中','高' 表15 severity 参数 参数类型 描述 id Integer 重要程度id,10 关键, 11 重要, 12 一般, 13 提示 name String 重要程度,关键, 重要, 一般, 提示 表16 status 参数 参数类型 描述 id Integer 状态id,新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6, name String 状态名称,新建,进行中,已解决, 测试中, 已关闭, 已拒绝 表17 tracker 参数 参数类型 描述 id Integer 工作项类型id, 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story name String 工作项类型名称,任务/Task, 缺陷/Bug, Epic, Feature, Story 状态码: 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 参数解释:实际工时,实际工时由详细工时自动累加和子工作项自动卷积计算 约束限制:不涉及 取值范围:最小长度:0 默认取值:不涉及 assigned_id 否 Integer 参数解释:处理人数字id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表,确认特定项目成员的用户数字id 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 begin_time 否 String 参数解释:开始时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 description 否 String 参数解释:工作项描述 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 developer_id 否 Integer 参数解释:开发人员数字id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表,确认特定项目成员的用户数字id 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 domain_id 否 Integer 参数解释:领域id, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性' 约束限制:正则表达式,^\d+$ 取值范围:最小值 14 最大值 20 默认取值:不涉及 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%' 取值范围:最小值 0 最大值 100 默认取值:不涉及 end_time 否 String 参数解释:结束时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 expected_work_hours 否 Double 参数解释:预计工时 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 iteration_id 否 Integer 参数解释:迭代id,可通过ListProjectIterationsV4接口获取指定项目的迭代列表 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 module_id 否 Integer 参数解释:模块id, 设置-工作项设置-模块设置内用户可新建模块 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 name 是 String 参数解释:标题 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 parent_issue_id 否 Integer 参数解释:父工作项的id 约束限制:创建子工作项时必填,父工作项的类型tracker_id不能为2 Task, 3 Bug 取值范围:最小长度 0 默认取值:不涉及 priority_id 是 Integer 参数解释: 优先级, 约束限制:正则表达式,^\d+$ 取值范围:1 低, 2 中, 3 高, 默认取值:不涉及 severity_id 否 Integer 参数解释: 重要程度, 约束限制:正则表达式,^\d+$ 取值范围:10 关键, 11 重要, 12 一般, 13 提示, 默认取值:不涉及 status_id 否 Integer 参数解释: 状态id, 约束限制:正则表达式,^\d+$ 取值范围:新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 默认取值:不涉及 tracker_id 是 Integer 参数解释: 工作项类型, 约束限制:Epic只能为 Feature的父工作项类型; Feature只能为Story的父工作项类型; Story只能为任务/Task,3缺陷/Bug的父; 取值范围:2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 默认取值:不涉及 new_custom_fields 否 Array of NewCustomField objects 参数解释: 用户自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 表4 NewCustomField 参数 是否必选 参数类型 描述 custom_field 否 String 参数解释: 自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 field_name 否 String 参数解释: 自定义字段页面显示的含义, 可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的name值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 value 否 String 参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的options值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 options String 字段可选值 region String 区域 id Integer 自定义字段ID identifier String 自定义字段唯一标识ID,可通过ListIssueCustomFields接口查询Scrum工作项 project_id Integer 项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 tracker_id Integer 工作项类型id 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story custom_field String 自定义字编号 type String 自定义字段类型 name String 自定义字段名称 sort Integer 显示排序 memo String 自定义字段描述 created String 创建时间 modified String 修改时间 is_delete Boolean 是否被删除 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求示例 Post https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields { "name" : "test", "type" : "text", "memo" : "描述", "options" : "0792b7d26cb74bd799cbae80063dc74a", "scrum_type" : "Story" }
  • 响应示例 状态码: 200 OK { "options" : "select1,select2", "region" : "southchina", "id" : 1, "identifier" : "81abca040032407bb62d52536d69ce2d", "project_id" : 2282492, "tracker_id" : 3, "custom_field" : "custom_field34", "type" : "select", "name" : "test", "sort" : 1, "memo" : "description", "created" : "2020-06-02T10:45:09Z", "modified" : 1, "is_delete" : false }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释:自定义字段名称 约束限制:正则表达式:^[a-zA-Z0-9\u4E00-\u9FA5\-_]{1,15}$ 取值范围:最小长度:1,最大长度:15 默认取值:不涉及 type 是 String 参数解释:自定义字段类型 约束限制:正则表达式,^(textArea|select|radio|text|checkbox|date|time_date|number)$ 对应参数解释: textArea 多行文本,select 下拉框,radio 单选框,text 单行文本,checkbox 多选框,date 日期,time_date 日期(包含时分,包含时分的日期类型的字段显示格式为:2019/10/10 10:10),number 数字 取值范围:最小长度:4,最大长度:9 默认取值:不涉及 options 否 String 参数解释:自定义字段类型 约束限制:正则表达式,^[\s\S]{1,6000}$ 取值范围:最小长度:1,最大长度:6000 默认取值:不涉及 memo 否 String 参数解释:自定义字段描述 约束限制:不涉及 取值范围:最小长度:0,最大长度:255 默认取值:不涉及 scrum_type 否 String 参数解释:当前新建的自定义字段应用的工作项类型 约束限制:正则表达式,^(Epic|Feature|Story|Task|Bug)$ 取值范围:最小长度:0,最大长度:7 默认取值:不涉及
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 表2 请求Body参数 参数 是否必选 参数类型 描述 project_name 是 String 项目名 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 exist Boolean 是否存在相同的项目名称 true 存在, false 不存在 状态码: 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 表2 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of UpdateChildUserNickNameRequestBody objects 修改的用户列表 表3 UpdateChildUserNickNameRequestBody 参数 是否必选 参数类型 描述 nick_name 是 String 用户昵称 user_id 是 String 用户id
共100000条