- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 管理项目群
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志（可选）
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 按用户查询工时（单项目）
- 按用户查询工时（多项目）
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项
- 查询工作项详情
- 更新工作项
- 删除工作项
- 获取子工作项
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据（处理人维度）
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的状态
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- OpenAPI管理
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询工作项附件列表
功能介绍
查询工作项附件列表
调用方法
请参见如何调用API。
URI
GET /v1/ipdprojectservice/projects/{project_id}/attachments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
issue_id |
是 |
String |
参数解释：工作项唯一Id。可以通过[查询工作项列表]或者[查询树状工作]接口获取，响应消息体中的id字段的值就是工作项ID 约束限制：正则表达式，^([0-9]{18,19})$ 默认取值：不涉及 |
|
source_project_id |
是 |
String |
参数解释： 工作项归属项目Id。当工作项类型为RR或Bug时，在提出项目查询提给外部的工作项附件时，project_id为提出项目Id，source_project_id为工作项归属项目Id。其他场景非必填。 约束限制： 正则表达式：[A-Za-z0-9]{32}。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释： 请求状态。 取值范围： 不涉及。 |
|
message |
String |
参数解释： 响应信息。 取值范围： 不涉及。 |
|
result |
Array of AttachmentEntity objects |
参数解释： 附件列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 附件Id。 取值范围： 不涉及。 |
|
issue_id |
String |
参数解释： 附件所属工作项Id。 取值范围： 不涉及。 |
|
file_size |
Long |
参数解释： 附件大小，单位为Byte，单个附件最大为50MB。 取值范围： 不涉及。 |
|
file_name |
String |
参数解释： 附件原名称。 取值范围： 不涉及。 |
|
attachment_type |
String |
参数解释： 附件类型，即文件扩展名。 取值范围： 不涉及。 |
|
modified_by |
UserEntity object |
参数解释： 修改人。 |
|
created_by |
UserEntity object |
参数解释： 创建人。 |
|
created_date |
String |
参数解释： 附件上传时间的时间戳。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
name |
String |
参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
nick_name |
String |
参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
https://{{endpoint}}/v1/ipdprojectservice/projects/68158c24d6d14e48bab08befefae150f/attachments?issue_id=984407816014831616响应示例
状态码：200
附件响应
{
"status" : "success",
"message" : null,
"result" : [ {
"id" : "984409429450334208",
"issue_id" : "984407816014831616",
"file_size" : "79234",
"file_name" : "IPD系统设备-缺陷-导入模板.xlsx",
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号"
},
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号"
},
"attachment_type" : "xlsx",
"created_date" : "1712631097000"
} ]
}状态码：400
通用错误响应
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
附件响应 |
|
400 |
通用错误响应 |
错误码
请参见错误码。
