CreateWorkitemAttachment - 上传工作项附件-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
项目协作	工作项附件	读写

请求语法

中心版

POST https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/attachments

Region版

POST https://{domain}/oapi/v1/projex/workitems/{id}/attachments

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	工作项唯一标识。
organizationId	string	path	是：中心版否：Region版	工作项唯一标识。
-	multipart/form-data	body	否
file	File	body	是	待上传文件。

请求示例

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/attachments' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --form 'file=@""'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/projex/workitems/{id}/attachments' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --form 'file=@""'

返回参数

参数	类型	描述	示例值
-	object
embedHtml	string	`<img>`片段，RICHTEXT 模式下可直接拷贝到工作项描述中使用。	`<img src="https://xxx.test.com/embed/xxx" />`
embedMarkdown	string	Markdown 图片片段，MARKDOWN 模式下可直接拷贝到工作项描述中使用。	`![image](https://xxx.test.com/embed/xxx)`
embedUrl	string	永久代理路径，用于在工作项描述中嵌入图片。与 url 的临时签名地址不同，不会过期。	https://xxx.test.com/embed/xxx
id	string	文件 id。	985353d622cc8521793e08****
name	string	名称。	name-xxx
size	integer	大小。	1024
suffix	string	后缀。	.png
url	string	文件下载地址，是个临时的下载地址，有实效性。	https://xxx.test.com

返回示例

{
    "embedHtml": "<img src="https://xxx.test.com/embed/xxx" />","embedMarkdown": "![image](https://xxx.test.com/embed/xxx)",
    "embedUrl": "https://xxx.test.com/embed/xxx",
    "id": "985353d622cc8521793e08****",
    "name": "name-xxx",
    "size": 1024,
    "suffix": ".png",
    "url": "https://xxx.test.com"
}

错误码

访问错误码中心查看 API 相关错误码。