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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: 32-character UUID of a project, which must be unique. Obtain the value by calling the API for Querying the Project List. The value of project_id in the response message body is the project ID. Constraints: Regular expression: [A-Za-z0-9]{32} Value range: 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 Obtaining the Sprint List of a Specified Project API. The value of the id field in the response message body is the release/sprint ID. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition : User token. Obtain the token by calling the Obtaining a User Token IAM 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 |
| 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
| Parameter | Type | Description |
|---|---|---|
| result | result object | Definition: Plan list. |
| status | String | Definition: Processing status of a request. Value range: success error: failed |
| 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 |
| img_url | String | Definition: Address for storing images. Value range: N/A |
| creator | creator object | Definition: Creator information. |
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot