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

上传工作项附件

功能介绍

上传工作项附件。

调用方法

请参见如何调用API。

URI

POST /v3/file/issue-upload

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表2 FormData参数

参数

是否必选

参数类型

描述

tinyfileName

是

File

参数解释：

上传的附件名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tinyFormDatas

是

String

参数解释：

表单数据。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

返回结果。

取值范围：

不涉及。

error

String

参数解释：

错误描述。

取值范围：

不涉及。

status

String

参数解释：

返回状态。

取值范围：

success：返回成功。

error：返回失败。
表4 result

参数

参数类型

描述

attachments

Array of Attachments objects

参数解释：

附件信息。

取值范围：

不涉及。
表5 Attachments

参数

参数类型

描述

id

Integer

参数解释：

附件Id。

取值范围：

不涉及。

filename

String

参数解释：

文件名。

取值范围：

不涉及。

filesize

Integer

参数解释：

文件大小。

取值范围：

不涉及。

digest

String

参数解释：

附件来源。

取值范围：

1：工作项本地上传的文档。

2：关联的文档。

downloads

String

参数解释：

下载内容。

取值范围：

不涉及。

description

String

参数解释：

描述。

取值范围：

不涉及。

authorIdentifier

String

参数解释：

上传人的32位uuid。

取值范围：

不涉及。

containerId

Integer

参数解释：

工作项id。

取值范围：

不涉及。

projectId

String

参数解释：

项目的uuid。

取值范围：

不涉及。

createdOn

String

参数解释：

历史记录创建的时间戳。

取值范围：

不涉及。

diskFilename

String

参数解释：

附件在服务器上实际名称。

取值范围：

不涉及。

diskDirectory

String

参数解释：

附件在服务器上的路径。

取值范围：

不涉及。

authorId

Integer

参数解释：

数字id。

取值范围：

不涉及。

projectNumId

Integer

参数解释：

项目数字id。

取值范围：

不涉及。

contentType

String

参数解释：

文件类型。

取值范围：

不涉及。

请求示例

{endpoint}/ProjectManAdapter/v3/file/issue-upload

tinyfileName：test.docx
tinyFormDatas：{"callBackUri":"issue/accessoriesUpload","callBackParam":"","business_tag":9184456,"project_id":"c15cc54e338d4506afd9bd8103071ff0","system_type":"projectMan","imgParam":{"type":"issue","issueId":9184456,"projectId":"c15cc54e338d4506afd9bd8103071ff0","description":"","updateIssueAccessorySizeCbUri":"issue/updateIssueAccessorySize","docManUpdateUri":"docman/prj/prj_upload_file","isError":"false","issueFiles":[]}}

响应示例

状态码：200

上传工作项附件接口成功的响应。

{
  "result": {
    "attachments": [
      {
        "id": 00000,
        "containerId": 0000000,
        "projectId": null,
        "projectNumId": 00000000,
        "containerType": "Issue",
        "filename": "testa.docx",
        "diskFilename": "63123f64-1afa-460a-9905-c7d3aca3bd77.docx",
        "filesize": 67075,
        "contentType": null,
        "digest": "1",
        "downloads": null,
        "authorId": 0000,
        "createdOn": null,
        "description": "",
        "diskDirectory": null,
        "authorIdentifier": null
      }
    ]
  },
  "error": null,
  "status": "success"
}

状态码

状态码

描述

200

上传工作项附件接口成功的响应。

错误码

请参见错误码。

相关文档