文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 看板项目的工作项/ 查询看板项目的工作项流转配置
更新时间：2024-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询看板项目的工作项流转配置

功能介绍

查询看板项目的工作项流转配置

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/work-items/workflow/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

devcloud项目的32位id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

board_id

是

String

看板id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：10

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

workflows

Array of WorkItemStatusFlowVo objects

流转数据
表5 WorkItemStatusFlowVo

参数

参数类型

描述

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
表6 StatusFlowDirectToVo

参数

参数类型

描述

parent_name

String

父状态的名称

parent_type

String

父状态的类型

status_id

String

状态id

name

String

状态名称

status_type

String

状态类型

enabled

Boolean

是否已开启状态流转， true： 开启, false 没开启

parent_id

String

父状态的uuid

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表8 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码。

相关文档