更新缩略图 - UpdateScrumPlanImageRequestBody
功能介绍
更新缩略图。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v3/plan/{project_id}/management/{plan_id}/img
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32个字符,由英文字母和数字组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
| plan_id | 是 | String | 参数解释: 发布/迭代唯一ID。可以通过获取指定项目的迭代列表接口获取,响应消息体中的id字段的值就是发布/迭代ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为10~32768个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| img_url | 是 | String | 参数解释: 缩略图url。 约束限制: 图片URI路径,格式为/v1/upload/{占位符}/{6位数字}/{文件名}.{扩展名}。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | result object | 参数解释: 规划列表的结果。 |
| status | String | 参数解释: 请求的处理状态。 取值范围: success:成功。 error:失败。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 规划的ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 规划的标题。 取值范围: 不涉及。 |
| type | String | 参数解释: 规划类型。 取值范围: gantt(甘特) mind(思维导图) |
| project_id | String | 参数解释: 所属项目的ID。 取值范围: 不涉及。 |
| img_url | String | 参数解释: 存储图片的地址。 取值范围: 不涉及。 |
| creator | creator object | 参数解释: 创建人的信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user_id | String | 参数解释: 创建人的用户ID。 取值范围: 不涉及。 |
| domain_id | String | 参数解释: 租户的ID。 取值范围: 不涉及。 |
| nick_name | String | 参数解释: 创建人的昵称。 取值范围: 不涉及。 |
| first_name | String | 参数解释: 创建人的账户名。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
PUT https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/management/bf56512ab4e544c29d03d068711ca56a/img
{
"img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
} 响应示例
状态码:200
更新缩略图响应信息
{
"result" : {
"id" : "bf56512ab4e544c29d03d068711ca56a",
"img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
},
"status" : "success"
} 状态码:400
无权限的错误响应
{
"error_code" : "PM.02100011",
"error_msg" : "无权限访问"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新缩略图响应信息 |
| 400 | 无权限的错误响应 |
错误码
请参见错误码。