- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志(可选)
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- 项目及成员
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 按用户查询工时(单项目)
- 按用户查询工时(多项目)
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项
- 查询工作项详情
- 更新工作项
- 删除工作项
- 获取子工作项
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据(处理人维度)
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的状态
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- OpenAPI管理
- 应用示例
- 附录
- 文档修订记录
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询看板项目的工作项流转配置
功能介绍
查询看板项目的工作项流转配置
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/work-items/workflow/config
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
devcloud项目的32位id 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
board_id |
是 |
String |
看板id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:10 最大长度:32768 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
workflows |
Array of WorkItemStatusFlowVo objects |
流转数据 |
参数 |
参数类型 |
描述 |
---|---|---|
parent_name |
String |
父状态的名称 |
parent_type |
String |
父状态的类型 |
status_id |
String |
状态id |
name |
String |
状态名称 |
status_type |
String |
状态类型 |
direct_to |
Array of StatusFlowDirectToVo objects |
流转到的数据 |
assign_to |
String |
处理人的uuid |
comment |
String |
评论内容 |
required_assign |
Boolean |
处理人是否必填 |
required_notes |
Boolean |
评论是否必填 |
field_type |
Boolean |
是否是字段值,true 处理人的信息是字段值, false 处理人的值是用户的信息,固定值 |
parent_id |
String |
父状态的uuid |
参数 |
参数类型 |
描述 |
---|---|---|
parent_name |
String |
父状态的名称 |
parent_type |
String |
父状态的类型 |
status_id |
String |
状态id |
name |
String |
状态名称 |
status_type |
String |
状态类型 |
enabled |
Boolean |
是否已开启状态流转, true: 开启, false 没开启 |
parent_id |
String |
父状态的uuid |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/workflow/config?board_id=5aef890d5a2d45b2b22f3e307e785715 GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/workflow/config?board_id=5aef890d5a2d45b2b22f3e307e785715
响应示例
状态码: 200
OK
{ "workflows" : [ { "parent_name" : "进行中", "parent_type" : "IN_PROGRESS", "status_id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "研发", "status_type" : "IN_PROGRESS", "direct_to" : [ { "parent_name" : "进行中", "parent_type" : "IN_PROGRESS", "status_id" : "d25fe91f7f6b489db5f804e66ac3b360", "name" : "研发", "status_type" : "IN_PROGRESS", "enabled" : false, "parent_id" : "beda5e42974c42a09e142faa1dc0fc98" } ], "assign_to" : "a360371833bf4c558f796fd707b44daf", "comment" : "A transfer to B", "required_assign" : false, "required_notes" : false, "field_type" : false, "parent_id" : "beda5e42974c42a09e142faa1dc0fc98" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。