文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的状态/ 查询工作项自定义状态的名字是否重复
更新时间:2025-09-11 GMT+08:00
分享

查询工作项自定义状态的名字是否重复

功能介绍

查询工作项自定义状态的名字是否重复。

调用方法

请参见如何调用API

URI

POST /v2/issue-status/check-name

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

projectUUId

String

参数解释

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

约束限制

支持中英文的32位字符串。

取值范围

不涉及。

默认取值

不涉及。

definedName

String

参数解释:

自定义状态名称。

约束限制:

支持中英文,不超过15长度的字符串。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回信息。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功。

error:返回失败。

表3 result

参数

参数类型

描述

exist

Boolean

参数解释:

自定义状态名称是否重复。

取值范围:

true(重复)

false(不重复)

请求示例

 POST http://{endpoint}/v2/issue-status/check-name

{
  "definedName" : "test1",
  "projectUUId" : "d2fc487f5a944d5e88bfbceedb7d6a86"
}

响应示例

状态码:200

CheckStatusName接口成功的响应。

{
  "result" : {
    "exist" : false
  },
  "status" : "success"
}

状态码

状态码

描述

200

CheckStatusName接口成功的响应。

错误码

请参见错误码

相关文档