云服务器内容精选

  • 响应示例 状态码: 200 OK { "records" : [ { "work_item_record_id" : "7401906a85de466c81fd90e22824eb19", "work_item_id" : "4633454879781163008", "project_id" : "526cefde62004de2b62b5e8dd2c2b3af", "work_item_statuses" : [ { "id" : "7401906a85de466c81fd90e22824eb19", "status" : { "id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "7401906a85de466c81fd90e22824eb19", "type" : "BACK LOG ", "description" : "demo", "parent_status_id" : "7401906a85de466c81fd90e22824aaaa" } } ] } ], "total" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 records Array of WorkitemStatusRecords objects 操作历史 total Integer 总数 表5 WorkitemStatusRecords 参数 参数类型 描述 work_item_record_id String 工作项的记录id,一个工作项对应一条记录 最小长度:32 最大长度:32 work_item_id String 工作项id project_id String devcloud项目的32位id 最小长度:32 最大长度:32 work_item_statuses Array of WorkitemStatus objects 操作历史 表6 WorkitemStatus 参数 参数类型 描述 id String 工作项状态变更记录的id,每次变更产生一条新的记录id 最小长度:1 最大长度:32 status status object 工作项的状态 表7 status 参数 参数类型 描述 id String 工作项的状态id 最小长度:1 最大长度:32 name String 状态名称 最小长度:1 最大长度:60 type String 工作项状态的类型, BACKLOG( "初始化"), READY("待启动"), IN_PROGRESS("进行中"), COMPLETE("已完成"), DONE("已结束"), description String 工作项状态的描述 parent_status_id String 工作项状态的父状态id 最小长度:1 最大长度:32 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects/{project_id}/work-items/status-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 从0开始 最小值:0 缺省值:0 limit 否 Integer 每页数量 最小1,最大100 最小值:1 最大值:100 缺省值:100
  • 响应示例 状态码: 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 表4 响应Body参数 参数 参数类型 描述 work_items Array of Workitems objects 工作项 total Integer 总数 表5 Workitems 参数 参数类型 描述 id String 工作项id description String 工作项描述 actual_work_hours Double 实际工时 assigned_user WorkitemUser object author WorkitemUser object begin_time String 工作项开始时间 created_time String 创建时间 tags Array of tags objects 标签 developer WorkitemUser object assigned_cc_user Array of WorkitemUser objects 抄送人 discover_version String 发现问题的版本 end_time String 工作项结束时间 done_ratio String 工作项进度值 expected_work_hours Double 预计工时 order String 顺序 parent_work_item_id String 父工作项的id release_version String 发布的版本 story_point String 故事点 domain domain object id, 领域 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' 其他 iteration iteration object 迭代 module module object 模块 priority String 工作项优先级 severity String 严重的程度 "提示", "一般", "严重", "致命" status status object 工作项状态 subject String 工作项标题 updated_time String 更新时间 sequence String 工作项编号 important String 重要程度 "关键", "重要", "一般", "提示" custom_fields Array of WorkitemCustomField objects 用户自定义字段 表6 tags 参数 参数类型 描述 id String 标签id name String 标签名 表7 WorkitemUser 参数 参数类型 描述 id String 用户32位uuid name String 用户名 nick_name String 昵称 表8 domain 参数 参数类型 描述 id String 领域id name String 领域 表9 iteration 参数 参数类型 描述 id String 迭代id name String 迭代名 表10 module 参数 参数类型 描述 id String 模块id name String 模块 表11 status 参数 参数类型 描述 id String 状态id name String 状态名称 表12 WorkitemCustomField 参数 参数类型 描述 field_id String 自定义字段id field_name String 自定义字段名称 field_type String 自定义字段类型, "Date","Number","DateTime", "MultiLineText","SingleLineText", "Select", "Checkbox" field_option_source String 自定义字段的选项源,CUSTOM,USER,DOMAIN,ITERATION,MODULE,TAG 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的数组[{},{}]) 状态码: 400 表13 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表14 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v4/projects/{project_id}/work-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String devcloud项目的32位id 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 从0开始 最小值:0 缺省值:0 limit 否 Integer 每页数量 最小1,最大100 最小值:1 最大值:100 缺省值:100 created_time_interval 否 String 创建工作项的时间(查询的起始时间,查询的结束时间)
  • 相关操作 对新创建的工作项,可以执行以下操作。 以下操作针对工作项的列表视图。 表2 工作项基本操作 操作项 说明 快捷编辑工作项 在工作项列表中,单击目标工作项标题右侧的“修改标题”或按快捷键T,可以编辑工作项标题。 在工作项列表中,单击目标工作项标题右侧的“修改处理人”或按快捷键A,可以快捷修改工作项处理人。 在工作项列表中,单击目标工作项标题右侧的“修改为自己”或按快捷键空格,可以将工作项处理人快速修改为自己。 在工作项列表中,单击目标工作项标题右侧的“修改结束日期”或按快捷键D,可以快捷修改工作项的结束日期。 编辑工作项 在工作项列表中,单击目标工作项所在行的字段值,即可修改编辑对应工作项字段。 快速新建子工作项 在工作项列表中,单击目标工作项标题右侧的“新建XX”,可以输入子工作项标题完成快速新建子工作项流程。 说明: 最底层工作项层级面板下的工作项不支持新建子工作项。 批量创建子 在工作项列表中,单击目标工作项标题右侧的“批量创建子”,可以输入多条子工作项标题完成快速批量创建子工作项流程。 说明: 最底层工作项层级面板下的工作项不支持新建子工作项。 关注工作项 在工作项列表中,单击目标工作项标题右侧的“关注工作项”,关注成功后操作按钮变成“取消关注工作项”,再次单击可取消关注。 复制工作项 在工作项列表中,单击目标工作项标题右侧的“复制工作项”,可以将当前工作项复制到目标项目中,目标项目类型仅支持看板项目。 拆分工作项 当前工作项若分解的不合理,您可以根据需要对其进行拆分。 在工作项列表中,单击目标工作项标题右侧的“拆分工作项”,可以将当前工作项拆分出2个或3个工作项,拆分出新工作项是源工作项的“被拆原工作项”,源工作项是拆分出新工作项“拆出新工作项”。 设置阻塞 当前工作项研发过程中遇到了风险阻塞,可以将该工作项设为阻塞。 在工作项列表中,单击目标工作项标题右侧的“设为阻塞”,可以选择“阻塞类型”和输入详细说明后,将工作项设为阻塞。 说明: 已阻塞工作项不支持更改状态。 已阻塞工作项不支持归档。 归档工作项 在工作项列表中,单击目标工作项标题右侧的“归档工作项”,可以将当前工作项归档。 已归档工作项可在下的“已归档工作项”中查看。 已归档工作项可进行“取消归档”操作。 删除工作项 在工作项列表中,单击目标工作项标题右侧的“归档工作项”,可以删除目标工作项。 说明: 工作项删除后,会进回收站。 进入回收站的工作项可以在“回收站”中还原和彻底删除,在回收站中还原后,工作项状态恢复至状态流的第一个状态。
  • 工作项层级状态配置 在“工作项层级配置”页面,可以对工作项层级进行状态配置。 单击工作项层级所在行,在“状态配置”中可以进行状态设置。 状态设置操作包括:创建状态、修改状态名称、修改状态类型、设置默认处理人、设置自动流转提交信息、添加子状态和删除状态。 创建状态 单击“状态设置”页签左上角“新建”,在“新建状态”弹窗输入信息进行创建。 修改状态名称 在“状态设置”页签状态列表中,单击状态名称可直接修改状态名称。 修改状态类型 在“状态设置”页签状态列表中,单击类型进行修改。 设置默认处理人 在“状态设置”页签状态列表中,可以为状态设置默认处理人。 单击设置默认处理人。 为该状态设置处理人信息。 处理人:可选择固定值和字段值。 评论:可为该状态设置默认评论信息。 评论可以设置是否“必填”,请根据需要设置。 设置完成后,可在工作项状态设置中生效。 设置自动流转提交信息 在“状态设置”页签状态列表中,单击状态所在行,弹出“为该状态设置代码提交信息”窗口。请根据实际情况设置代码提交信息包括fix、close和resolve。fix、close、resolve如何触发工作项自动流转请参见代码托管中关联工作项。 添加子状态 在“状态设置”页签状态列表中,单击状态所在行,弹出“添加子状态列”窗口,请根据实际情况添加子状态。 删除状态 在“状态设置”页签状态列表中,单击状态所在行,根据提示信息完成状态删除操作。 含有子状态的状态不能删除。 含有工作项的状态不能删除。 系统内置的状态类型为“新建”的状态不能删除。 当只有一个“已结束”状态时,该状态不能删除。
  • 设置工作状态流转方向(状态) 根据实际需要配置工作项状态的流转状态。工作项状态的流转状态配置好后,在工作项“列表”视图页面中单击工作项的状态,根据当前类型的状态显示可流转的状态。 单击“流转方向”页签,进入状态流转方向设置。 状态流转方向决定当前状态下的工作项是否能正常流转到目标状态,会影响工作项状态设置及拖动等功能。 勾选或取消勾选即可设置某状态是否能流转至某状态。 勾选表示可流转,不勾选表示不能流转。
  • 修改成员角色 项目创建者、项目的管理员(项目经理和测试经理)才可以给成员设置项目角色,默认项目角色类型如下: 项目创建者 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 项目添加好成员后,可以给项目成员设置不同角色。在成员管理找到目标角色后,单击成员所在行的角色名称,通过下拉列表重新选择成员角色类型即可。 如果默认角色类型不能满足实际需求,可以自定义角色类型(如:产品经理)并赋予相关权限,详细操作请参见服务权限管理。
  • 邀请成员 管理员创建了用户,需要将用户添加为项目的成员,才能看到项目信息。如果未添加至任何项目,用户登录后将看不到任何项目信息。 单击“通过链接邀请”。 在“邀请成员”页面您直接扫描二维码加入成员后,即可看到所在项目的信息。 单击“复制链接”获取项目链接,分享项目链接可邀请成员自由加入项目。待被邀请人进入该链接后提交申请。 (可选)管理员在“待审核”成员列表中单击通过审核即完成邀请。 可以根据需要开启或关闭“通过邀请加入该项目需要审核” 默认审核:管理员审核通过后,用户即可加入成员。 关闭审核:用户可自由选择加入项目。如果审核列表中存在用户待审核,则不能关闭。 为了保障公司安全,通过分享二维码或分享项目链接邀请加入的成员,默认需要等待管理员再次审批。管理员也可以根据实际情况设置取消审核。
  • 配置工作项层级状态流转方向 根据实际需要配置工作项状态的流转状态。工作项状态的流转状态配置好后,在工作项“列表”视图页面中单击工作项的状态,根据当前类型的状态显示可流转的状态。 单击“状态配置”下的“流转方向”页签,进入状态流转方向设置。 状态流转方向决定当前状态下的工作项是否能正常流转到目标状态,会影响工作项状态设置及拖动等功能。 勾选或取消勾选即可设置某状态是否能流转至某状态。 勾选表示可流转,不勾选表示不能流转。
  • 列表视图 “显示方式”选择“列表”视图模式,工作项将以列表形式进行展示。 在看板页面单击“显示”,选择“列表”,可以切换到“列表”视图方式。 在列表视图中,可以根据需要做如下操作: 快速创建 单击表头下第一行左侧“快速新建”可在行内快速创建工作项。 批量创建 单击表头下第一行左侧“批量创建”可批量创建操作。 表头功能 选择型字段支持过滤、字段支持排序。将鼠标移动至表头,则自动显示过滤和排序按钮。 支持“设置显示字段”以及“自动换行”,单击表头右侧按钮进入设置。 表格功能 支持单元格编辑、单行选择。 标题列支持功能(鼠标悬浮于标题列时,单击标题右侧出现的): 修改标题、修改处理人、修改为自己(即将工作项的处理人设置为当前用户)、修改状态、修改结束日期、新建需求、批量创建子(即批量创建子工作项,当层级不为最后层级的时候显示)、关注工作项/取消关注工作项、复制工作项、拆分工作项、设置阻塞/取消阻塞、归档工作项/取消归档工作项、删除工作项。 表格底部右方显示工作项总数。
  • 工作项分组 每个视图都可以将工作项进行分组显示,默认不分组,操作入口可在右上方单击“分组”进入。 每种视图模式下,分组操作会不同。请根据实际需要选择视图模式进行操作。 卡片视图分组 “默认”:默认不进行分组。 “按处理人”:按照工作项的处理人进行分组显示,每一行为处理人相同的工作项,每一列为状态相同的工作项,单击图标继续新增工作项,工作项支持跨行和跨列进行拖放。 列表视图分组 “默认”:默认不进行分组。 “按列”:按列分组后,列表视图呈现各个状态的“行”,每一“行”展开后显示当前状态下的工作项。 “按处理人”:按处理人分组后,列表视图呈现各个成员的“行”,每一“行”展开后显示处理人为当前成员的工作项。 树视图分组 “默认”:默认不进行分组。 “按列”:按列分组后,呈现按照状态分类的树。 “按处理人”:按处理人分组后,呈现按照成员分类的树。
  • 修改工作项 在“卡片”视图中,支持快速修改工作项,如工作项拖拽、列拖拽、工作项卡片编辑详情。 工作项拖拽 鼠标左键单击卡片不放,拖拽到其他列上,当显示蓝色虚线框与“拖动到此处”的文字提示时,松开鼠标左键即可将工作项移动到指定位置。 是否能拖拽,跟起始状态能否流转到目标状态有关,详情见状态配置中的状态流转方向配置。当工作项不可拖拽到指定位置时,蓝色虚线框与“拖动到此处”提示不会出现。 列拖拽 鼠标左键单击列名称附近位置不放,左右拖拽到其他位置上,当显示蓝色虚线框时,松开鼠标左键即可将列移动到指定位置(待启动状态列不能进行拖拽)。 编辑工作项详情 工作项在“卡片”视图模式,可快速编辑处理人和结束日期信息。 单击工作项卡片可进行工作项详情查看及详情编辑,选择对应信息进行编辑后,单击右上方“保存”进行保存,详情编辑参见工作项详情。