文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的状态/ 查询项目的状态属性 - ListIssueStatusAttributes
更新时间:2025-12-11 GMT+08:00
分享

查询项目的状态属性 - ListIssueStatusAttributes

功能介绍

查询项目的状态属性。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/issue-status-attributes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

issue_status_attributes

Array of IssueStatusAttribute objects

工作项状态属性

total

Integer

总数

表4 IssueStatusAttribute

参数

参数类型

描述

project_id

String

参数解释:

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

取值范围:

不涉及。

name

String

参数解释:

状态名称。

取值范围:

不涉及。

type

String

参数解释:

状态类型。

取值范围:

开始态

进行态

结束态

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{endpoint}/v2/a6a33eca679b435b85574bd2fde46ce7/issue-status-attributes

响应示例

状态码:200

查询项目下状态属性接口成功的响应。

{
  "total" : 3,
  "issue_status_attributes" : [ {
    "name" : "开始态",
    "type" : "START_STATUS",
    "project_id" : "792baf0747b1469ea9fc0f4a5b0bac07"
  }, {
    "name" : "进行态",
    "type" : "PROCESS_STATUS",
    "project_id" : "792baf0747b1469ea9fc0f4a5b0bac07"
  }, {
    "name" : "结束态",
    "type" : "DONE_STATUS",
    "project_id" : "792baf0747b1469ea9fc0f4a5b0bac07"
  } ]
}

状态码

状态码

描述

200

查询项目下状态属性接口成功的响应。

400

错误信息

错误码

请参见错误码

相关文档