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

Updating a Thumbnail

Function

This API is used to update a thumbnail.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/plan/{project_id}/management/{plan_id}/img

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

Regular expression: [A-Za-z0-9]{32}

Options:

N/A

Default value:

N/A

plan_id

Yes

String

Definition:

Unique ID of a release or sprint. You can obtain the release/sprint ID using the Querying the Release/Sprint List API. The value of the id field in the response message body is the release/sprint ID.

Constraints:

N/A

Options:

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 the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

img_url

Yes

String

Definition:

Thumbnail URL.

Constraints:

Regular expression: /v1/upload/%s/\d{6}/[a-zA-Z0-9]+.[a-zA-Z]

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Plan list.

status

String

Definition:

Processing status of a request.

Value range:

success: successful

error: failed

Table 5 result

Parameter

Type

Description

id

String

Definition:

Plan ID.

Value range:

N/A

name

String

Definition:

Plan title.

Value range:

N/A

type

String

Definition:

Plan type.

Value range:

gantt (Gantt chart)

mind (mind map)

project_id

String

Definition:

Project ID.

Value range:

N/A

creator

creator object

Definition:

Creator information.

Table 6 creator

Parameter

Type

Description

user_id

String

Definition:

User ID of the creator.

Value range:

N/A

domain_id

String

Definition:

Tenant ID.

Value range:

N/A

nick_name

String

Definition:

Creator alias.

Value range:

N/A

first_name

String

Definition:

Username of the creator.

Value range:

N/A

Example Requests

PUT https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/management/bf56512ab4e544c29d03d068711ca56a/img

{
  "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
}

Example Responses

Status code: 200

Updates the thumbnail response.

{
  "result" : {
    "id" : "bf56512ab4e544c29d03d068711ca56a",
    "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Updates the thumbnail response.

Error Codes

See Error Codes.