更新时间:2025-07-28 GMT+08:00
分享

查询工作项附件列表

功能介绍

查询工作项附件列表

调用方法

请参见如何调用API

URI

GET /v1/ipdprojectservice/projects/{project_id}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

正则表达式,^[A-Za-z0-9]{32}$。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

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

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求状态。

取值范围:

不涉及。

message

String

参数解释:

响应信息。

取值范围:

不涉及。

result

Array of AttachmentEntity objects

参数解释:

附件列表。

表4 AttachmentEntity

参数

参数类型

描述

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

参数解释:

附件上传时间的时间戳。

取值范围:

不涉及。

表5 UserEntity

参数

参数类型

描述

id

String

参数解释:

用户id,可通过获取当前用户信息接口获取,响应消息体中的id字段的值就是用户id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

用户名称。

约束限制:

最小长度:2,最大长度:64。

取值范围:

不涉及。

默认取值:

不涉及。

nick_name

String

参数解释:

用户昵称。

约束限制:

最小长度:2,最大长度:30。

取值范围:

不涉及。

默认取值:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

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

通用错误响应

错误码

请参见错误码

相关文档