更新时间:2025-09-11 GMT+08:00
分享

查询系统自定义状态

功能介绍

查询系统自定义状态。

调用方法

请参见如何调用API

URI

GET /v2/issue-status/optional-status-config

表1 Query参数

参数

是否必选

参数类型

描述

projectUUId

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

trackerId

Integer

参数解释

工作项类型。

约束限制

2,3,5,6,7。

取值范围

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

请求返回结果。

status

String

参数解释:

请求状态信息。

取值范围:

success:返回成功。

error:返回失败。

表3 result

参数

参数类型

描述

issueStatus

Array of IssueStatusConfigsV2 objects

参数解释:

工作项状态。

表4 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的集合。

取值范围:

不涉及。

表5 IssueStatusAttributeV1

参数

参数类型

描述

id

String

参数解释:

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

取值范围:

不涉及。

name

String

参数解释:

状态名称。

取值范围:

不涉及。

type

String

参数解释:

状态类型。

取值范围:

开始态

进行态

结束态

请求示例

GET https://{endpoint}/v2/issue-status/optional-status-config?projectUUId=eaef5adb8c234cbda9c51ad51ff90396&trackerId=7

响应示例

状态码:200

ListOptionalStatusConfig接口成功的响应。

{
  "result" : {
    "issueStatus" : [ {
      "id" : "1daafaf5cfaa45f8a0737a0f38efb2f2",
      "statusId" : 7,
      "definedName" : "测试1",
      "position" : 2,
      "flag" : 1,
      "description" : "描述示例。",
      "statusAttribute" : 35098945,
      "statusAttributeName" : "开始态"
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

ListOptionalStatusConfig接口成功的响应。

错误码

请参见错误码

相关文档