Updated on 2025-08-13 GMT+08:00

Downloading a Task Creation Template

Function

This API is used to download a template exported based on an existing task.

URI

POST /v5/{project_id}/templates/download

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. The default value application/json is recommended. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a response is returned, the value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

files

Yes

Array of strings

Name of the file to be downloaded.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

File

Downloaded template file.

Example Request

Downloading a template for importing tasks in batches

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/templates/download

{
  "files" : [ "2e69ebb1-f06d-4eb2-a789-2883629jb204_postgresql_20250704024811.xlsx" ]
}

Example Response

Status code: 200

OK

""

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.