文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 工作项描述中添加图片
更新时间：2025-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

工作项描述中添加图片

功能介绍

工作项描述中添加图片。

调用方法

请参见如何调用API。

URI

POST /v2/upload/upload-img

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。
表2 FormData参数

参数

是否必选

参数类型

描述

file

是

File

参数解释：

上传的图片。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

projectId

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

32位的数字和字母组成的字符串。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

返回结果。

取值范围：

不涉及。

status

String

参数解释：

返回状态。

取值范围：

success：返回成功。

error：返回失败。
表4 result

参数

参数类型

描述

imgId

String

参数解释：

图片id。

取值范围：

不涉及。

imgUrl

String

参数解释：

图片在服务器的存放地址。

取值范围：

不涉及。

请求示例

{endpoint}/v2/upload/upload-img

file：test.png
projectId：a6a33eca679b435b85574bd2fde46ce7

响应示例

状态码：200

描述添加图片接口成功的响应。

{
  "result" : {
    "imgId" : "1",
    "imgUrl" : "/v1/upload/a8ac165097ff4e42bcfb234dd27d30a6/202508/1756281236230640580.jpg"
  },
  "status" : "success"
}

状态码

状态码

描述

200

描述添加图片接口成功的响应。

错误码

请参见错误码。

相关文档