文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD附件管理/ 下载工作项描述中的图片 - DownloadIpdImageInIssue
更新时间:2026-09-01 GMT+08:00
分享

下载工作项描述中的图片 - DownloadIpdImageInIssue

功能介绍

根据图片名称下载工作项描述中的图片。

调用方法

请参见如何调用API

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:workitem:get

Read

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v2/ipdprojectservice/projects/{project_id}/images

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

issue_id

String

参数解释

工作项唯一ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制

不涉及。

取值范围

18~19个字符的数字字符串。

默认取值

不涉及。

file_name

String

参数解释

工作项描述中的图片名称。

约束限制

35~38个字符,由32个英文字母和数字加上图片后缀名(.png.jpg.jpeg.gif.bmp.tiff.svg)组成。

取值范围

不涉及

默认取值

不涉及

field_code

String

参数解释

富文本字段Code值。可选值可以通过查询字段模板列表接口获取,响应体中的code就是字段唯一标识。

约束限制

2~32个字符。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

-

File

图片文件内容。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v2/ipdprojectservice/projects/e2569a971657464f810949e839ec5640/images?issue_id=1071125987320569856&file_name=f401ab8826b1426285910e6c5da80d07.png

响应示例

状态码:200

图片文件内容。

""

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

状态码

状态码

描述

200

图片文件内容。

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档