Updated on 2025-09-10 GMT+08:00

Saving a Project Template

Function

This API is used to save a project template.

Calling Method

For details, see Calling APIs.

URI

POST /v2/project-template/template

Request Parameters

Table 1 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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

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

name

No

String

Definition:

Template name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

is_public

No

Integer

Definition:

Whether to set the template as default.

Constraints:

N/A

Value range:

0 (no)

1 (yes)

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

id

Integer

Definition:

Template ID.

Value range:

N/A

name

String

Definition:

Template name.

Value range:

N/A

type

String

Definition:

Template type

Value range:

Scrum

Example Requests

Creating a template named 234548

{endpoint}/v2/project-template/template?_=1753238263835

{
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "name" : "234548",
  "is_public" : 1
}

Example Responses

Status code: 200

The response for successfully saving the project template interface.

{
  "result" : {
    "id" : 384846,
    "name" : "234548",
    "type" : "scrum"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

The response for successfully saving the project template interface.

Error Codes

See Error Codes.