文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询Scrum项目的工作项流转配置
更新时间：2022-12-08 GMT+08:00
查看PDF
分享

查询Scrum项目的工作项流转配置

功能介绍

查询Scrum项目的工作项流转配置

URI

GET /v4/projects/{project_id}/issues/workflow/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

devcloud项目的32位id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

tracker_id

是

Integer

工作项类型id [2,3,4,5,6,7]

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：10

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

workflows

Array of ScrumStatusFlowVo objects

流转数据
表5 ScrumStatusFlowVo

参数

参数类型

描述

id

String

流转数据的uuid

name

String

状态名称

status_id

Integer

状态id

direct_to

Array of ScrumStatusFlowDirectToVo objects

流转到的数据
表6 ScrumStatusFlowDirectToVo

参数

参数类型

描述

id

String

流转数据的uuid

status_id

Integer

状态id

name

String

状态名

enabled

Boolean

是否开启流转

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7

响应示例

状态码： 200

OK

{
  "workflows" : [ {
    "id" : "2e645dbab6874a3eafa77ef06b97ea75",
    "name" : "新建",
    "status_id" : 1,
    "direct_to" : [ {
      "id" : "2e645dbab6874a3eafa77ef06b97ea75",
      "status_id" : 2,
      "name" : "新建",
      "enabled" : true
    } ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。