文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 上传工作项附件 - UploadAttachments
更新时间:2026-09-01 GMT+08:00
分享

上传工作项附件 - UploadAttachments

功能介绍

上传工作项附件

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:attachment:upload

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

POST /v4/projects/{project_id}/issues/{issue_id}/attachments/upload

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

32个字符,由英文字母和数字组成。

取值范围:

不涉及。

默认取值

不涉及。

issue_id

Integer

参数解释:

工作项ID,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制:

不涉及。

取值范围:

≥0。

默认取值:

不涉及。

请求参数

表2 FormData参数

参数

是否必选

参数类型

描述

attachment

File

参数解释:

附件文件。

约束限制:

最大上传大小为50M。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

disk_filename

String

参数解释:

云盘存储名。

取值范围:

不涉及。

file_name

String

参数解释:

文件名。

取值范围:

不涉及。

id

Integer

参数解释:

关联ID。

取值范围:

不涉及。

issue_id

Integer

参数解释:

工作项ID。

取值范围:

不涉及。

project_id

String

参数解释:

项目ID。

取值范围:

不涉及。

size

String

参数解释:

文件大小。

取值范围:

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

request_id

String

参数解释

请求的ID,系统自动生成。

取值范围

不涉及。

请求示例

POST https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/attachments/upload

------WebKitFormBoundary1kuNerRnRVVybt65
Content-Disposition: form-data; name="attachment"; filename="demo.PNG"
Content-Type: image/png

响应示例

状态码:200

上传工作项附件的返回信息。

{
  "disk_filename" : "adfadsfasdfa.jpg",
  "file_name" : "demo.jpg",
  "id" : "1234,",
  "issue_id" : "1232,",
  "project_id" : "2c42a6d37ccc4197bf0b3dbe91be021a",
  "size" : "1233"
}

状态码

状态码

描述

200

上传工作项附件的返回信息。

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档