文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 验证模块是否重名
更新时间：2025-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

验证模块是否重名

功能介绍

验证模块是否重名。

调用方法

请参见如何调用API。

URI

GET /v2/module/module-name-validation

表1 Query参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

module_name

否

String

参数解释：

模块的名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

返回的结果对象。

status

String

参数解释：

项目返回状态。

取值范围：

success：成功

error：失败
表4 result

参数

参数类型

描述

exist

Boolean

参数解释：

是否存在当前模块名称

取值范围：

true|false

true：代表模块名称存在

false：代表模块名称不存在

请求示例

GET http://{endpoint}/v2/module/module-name-validation?module_name=%E9%98%BF%E8%90%A8%E8%BE%BE%E6%98%AF&project_id=5192de5eb435430c8cd41c6ae6028848&_=1753684289029

响应示例

状态码：200

验证模块是否重名接口成功的响应。

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

状态码

状态码

描述

200

验证模块是否重名接口成功的响应。

错误码

请参见错误码。