云服务器内容精选

  • 响应示例 状态码: 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 devcloud项目的32位id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移量 缺省值:0 limit 否 Integer 一次返回的数据,最小1,最大100 最小值:1 最大值:100 缺省值:10 tracker_id 否 Integer 自定义字段支持的工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 状态总数 issue_statuses Array of IssueStatus objects 状态列表 表5 IssueStatus 参数 参数类型 描述 id String 状态uuid status_id Integer 状态数字id name String 状态名称 tracker_ids Array of integers 关联的工作项类型列表 status_attribute StatusAttribute object 状态属性类型 开始态,进行态,结束态 表6 StatusAttribute 参数 参数类型 描述 id Integer 状态属性id name String 状态属性名称 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表8 响应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 错误码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 iteration_ids 是 Array of integers 迭代的id 数组长度:1 - 10
  • 请求示例 Post https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb2/issues/123456/work-hours { "start_date" : "2023-05-15", "due_date" : "2023-05-15", "work_hours" : 2.0, "work_hours_type_id" : 21 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 added_work_hours Array of added_work_hours objects 已添加的工时列表 表5 added_work_hours 参数 参数类型 描述 work_hours_id String 工时id issue_id Integer 添加工时对应的工作项id user_name String 工时添加用户的用户名 user_nick_name String 工时添加用户的用户昵称 work_date String 工时日期 年-月-日 work_hours Double 工时数 work_hours_type_name String 工时类型名称 (项目预设工时类型id及名称对照:21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App), 26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假) 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 ok { "added_work_hours" : [ { "work_hours_id" : "7da14cf9f3c111eda5a5fa163ec9f6c1", "issue_id" : 123456, "user_name" : "user_name", "user_nick_name" : "O_O", "work_date" : "2023-05-15", "work_hours" : "2.0", "work_hours_type_name" : "研发设计" } ] }
  • URI POST /v4/projects/{project_id}/issues/{issue_id}/work-hours 表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 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 start_date 是 String 参数解释:工时开始日期,年-月-日 约束限制:正则表达式, ^\d{4}-\d{2}-\d{2}$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 due_date 是 String 参数解释:工时结束日期,年-月-日 约束限制:正则表达式, ^\d{4}-\d{2}-\d{2}$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 work_hours 是 Double 参数解释:工时总数(若工时日期范围包含多天,单日工时将设为“工时总数/天数”) 约束限制:不涉及 取值范围:最小值:0.0,最大值:100000000 默认取值:不涉及 work_hours_type_id 否 Integer 参数解释:工时类型id (项目预设工时类型id及名称对照:21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App), 26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假) 约束限制:不涉及 取值范围:最小值:21,最大值:34 默认取值:不涉及
  • 响应示例 状态码: 200 OK { "total" : 1, "modules" : [ { "module_id" : 1, "module_name" : "demo", "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2", "user_num_id" : 4091, "user_name" : "demo_user_name_06", "nick_name" : "demo" }, "deepth" : 1, "is_parent" : true, "children" : [ { "module_id" : 1, "module_name" : "demo", "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2", "user_num_id" : 4091, "user_name" : "demo_user_name_06", "nick_name" : "demo" }, "deepth" : 1, "is_parent" : true, "parent_module_id" : 1 } ] } ] }
  • URI GET /v4/projects/{project_id}/modules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移量 缺省值:0 limit 否 Integer 一次返回的数据,最小1,最大100 最小值:1 最大值:100 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 模块总数 modules Array of ProjectModule objects 模块列表 表5 ProjectModule 参数 参数类型 描述 module_id Integer 模块id module_name String 模块名称 owner ModuleOwner object deepth Integer 模块层级 is_parent Boolean 是否是父级,true 父模块, false 非父模块 children Array of ProjectChildModule objects 子模块信息 表6 ProjectChildModule 参数 参数类型 描述 module_id Integer 模块id module_name String 模块名称 owner ModuleOwner object deepth Integer 模块层级 is_parent Boolean 是否是父级,true 父模块, false 非父模块 parent_module_id Integer 父模块id 表7 ModuleOwner 参数 参数类型 描述 user_id String 用户32位字符串id user_num_id Integer 用户数字id user_name String 用户名称 nick_name String 用户昵称 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code 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 错误码