查询工作项附件列表
功能介绍
查询工作项附件列表
调用方法
请参见如何调用API。
URI
GET /v1/ipdprojectservice/projects/{project_id}/attachments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
参数解释: 返回状态。 取值范围: success:响应成功 error:响应失败 |
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 |
参数解释: 附件类型,即文件扩展名。 取值范围: 图片:bmp、png、jpg、gif、icon、ico、svg PDF:pdf 音视频:mp3、mp4、webm、wav、ogg 文本:txt、sh、js、ts、java、php、css、html、xml、sql、rb、py、json html:docx、pptx、xlsx markdown:md |
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" : "无操作权限" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ShowIpdAttachmentByWorkItemIdSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ShowIpdAttachmentByWorkItemIdRequest request = new ShowIpdAttachmentByWorkItemIdRequest(); request.withProjectId("{project_id}"); try { ShowIpdAttachmentByWorkItemIdResponse response = client.showIpdAttachmentByWorkItemId(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowIpdAttachmentByWorkItemIdRequest() request.project_id = "{project_id}" response = client.show_ipd_attachment_by_work_item_id(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowIpdAttachmentByWorkItemIdRequest{} request.ProjectId = "{project_id}" response, err := client.ShowIpdAttachmentByWorkItemId(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
附件响应 |
400 |
通用错误响应 |
错误码
请参见错误码。