Updated on 2026-10-27 GMT+08:00

Checking Whether the Module Name Is Duplicate

Function

This API is used to check whether the module name is duplicate.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /v2/module/module-name-validation

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
module_name	No	String	Definition: Module name. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result object.
status	String	Definition: Returned status of a project. Value range: success: successful error: failed

**Table 4** result
Parameter	Type	Description
exist	Boolean	Definition: Whether the current module name exists. Value range: true and false true: The module name exists. false: The module name does not exist.

Example Requests

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

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Response to a successful request for checking whether the module name is duplicate.

Error Codes

See Error Codes.

Parent topic: Work Items of a Scrum Project