Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Checking Whether a Template Can Be Saved
Updated on 2025-09-10 GMT+08:00

Checking Whether a Template Can Be Saved

Function

This API is used to check whether a template can be saved.

Calling Method

For details, see Calling APIs.

URI

GET /v2/project-template/name-validation

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Template 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 forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 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.

status

String

Definition:

Returned status.

Value range:

N/A

Table 4 result

Parameter

Type

Description

exist

Boolean

Definition:

Whether the current module name exists.

Value range:

N/A

Example Requests

Saving as a template

{endpoint}/v2/project-template/name-validation?name=1234&_=1753237057613

Example Responses

Status code: 200

Verify whether the template can successfully save the response from the interface.

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

Status Codes

Status Code

Description

200

Verify whether the template can successfully save the response from the interface.

Error Codes

See Error Codes.