文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的状态/ 给自定义状态配置工作项类型
更新时间:2025-09-11 GMT+08:00
分享

给自定义状态配置工作项类型

功能介绍

给自定义状态配置工作项类型。

调用方法

请参见如何调用API

URI

POST /v2/issue-status/batch-tracker-config

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

projectUUId

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

由字母和数字组成的32位字符串。

取值范围

不涉及。

默认取值

不涉及。

trackerId

String

参数解释

工作项类型id。

约束限制

2,3,5,6,7。

取值范围

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

默认取值

不涉及。

ids

Array of strings

参数解释:

自定义状态的id数组,可通过添加系统自定义状态接口获取,响应体中的result字段中的id就是自定义状态的id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回结果。

取值范围:

success: 返回成功。

error: 返回失败。

表4 result

参数

参数类型

描述

issueStatusConfigs

Array of IssueStatusConfigsV2 objects

参数解释:

工作项状态。

表5 IssueStatusConfigsV2

参数

参数类型

描述

definedName

String

参数解释:

自定义状态名称。

取值范围:

不涉及。

description

String

参数解释:

自定义状态的描述。

取值范围:

不涉及。

flag

Integer

参数解释:

状态是否为自定义状态。

取值范围:

0(不是自定义状态)

1(是自定义状态)

id

String

参数解释:

自定义状态id。

取值范围:

不涉及。

is_closed

Boolean

参数解释:

自定义状态是否为结束态。

取值范围:

true(是结束态)

false(不是结束态)

is_initial

Boolean

参数解释:

自定义状态是否初始化。

取值范围:

true(是初始化)

false(不是初始化)

position

Integer

参数解释:

自定义状态在页面中的位置。

取值范围:

不涉及。

statusAttribute

Integer

参数解释:

自定义状态类型。

取值范围:

不涉及。

issueStatusAttribute

IssueStatusAttributeV1 object

参数解释:

工作项状态属性。

statusAttributeName

String

参数解释:

自定义状态属性名称。

取值范围:

开始态

进行态

结束态

statusId

Integer

参数解释:

自定义状态数字id。

取值范围:

不涉及。

trackerId

Integer

参数解释:

工作项类型。

取值范围:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

trackerList

Array of integers

参数解释:

工作项类型即trackerId的集合。

取值范围:

不涉及。

表6 IssueStatusAttributeV1

参数

参数类型

描述

id

String

参数解释:

项目32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

取值范围:

不涉及。

name

String

参数解释:

状态名称。

取值范围:

不涉及。

type

String

参数解释:

状态类型。

取值范围:

开始态

进行态

结束态

请求示例

POST http://{endpoint}/v2/issue-status/batch-tracker-config

{
  "projectUUId" : "d2fc487f5a944d5e88bfbceedb7d6a86",
  "trackerId" : "6",
  "ids" : [ "c874570a75304e0aa2ff1172ae30ea4a" ]
}

响应示例

状态码:200

BatchCreateTrackerConfig接口成功的响应。

{
  "result" : {
    "issueStatusConfigs" : [ {
      "id" : "298963741dbb40eb8a186575b5ab00bb",
      "statusId" : 15,
      "definedName" : "test1",
      "position" : 15,
      "flag" : 1,
      "description" : "描述示例。",
      "statusAttribute" : 35099694,
      "statusAttributeName" : "结束态"
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

BatchCreateTrackerConfig接口成功的响应。

错误码

请参见错误码

相关文档