获取附件列表 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

principal_type

string

必需

当前附件关联的资源的类型。必填参数。Allowed values: work_item, work_item_deliverable, test_case, test_run, idea, ticket

示例值:

work_item

principal_id

string

必需

当前附件关联的资源的类型的id。必填参数。

示例值:

comment_id

string

可选

当前附件关联的资源评论的id。当需要向资源评论的上传文件或者代码段时，需要传入该参数。

示例值:

Header 参数

Content-Type

string

必需

multipart/form-data或者application/json。向资源和资源评论上传文件类型的附件时，该值为multipart/form-data，向资源评论上传代码段的附件时，该值为application/json。

示例值:

application/json

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://open.pingcode.com/v1/attachments?principal_type=work_item&principal_id={work_item_id}'

返回响应

🟢200成功

application/json

Body

page_size

integer

必需

page_index

integer

必需

total

integer

必需

values

array [object {13}]

必需

id

string

必需

url

string

必需

title

string

必需

size

integer

必需

type

string

必需

format

string

可选

content

string

可选

line

integer

可选

created_at

integer

必需

created_by

object

必需

file_type

string

可选

ext

string

可选

download_url

string

可选

示例

{
    "page_size": 30,
    "page_index": 0,
    "total": 2,
    "values": [
        {
            "id": "5da588ca84c7377a5d327e6d",
            "url": "https://rest_api_root/v1/attachments/5da588ca84c7377a5d327e6d?principal_type=work_item&principal_id=5edca524cad2fa1125cb0630&comment_id=59f72dfaeadb5b5197b7da6d",
            "title": "这是一个代码片段",
            "size": 16,
            "type": "snippet",
            "format": "javascript",
            "content": "const a = 'abc';",
            "line": 1,
            "created_at": 1583290347,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            }
        },
        {
            "id": "5da588ca84c7377a5d327e6f",
            "url": "https://rest_api_root/v1/attachments/5da588ca84c7377a5d327e6f?principal_type=work_item&principal_id=5edca524cad2fa1125cb0630&comment_id=59f72dfaeadb5b5197b7da6d",
            "title": "这是一个图片类型的附件",
            "size": 1024,
            "type": "file",
            "file_type": "image",
            "ext": "png",
            "download_url": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839b.png",
            "created_at": 1583290347,
            "created_by": {
                "id": "a0417f68e846aae315c85d24643678a9",
                "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
                "name": "john",
                "display_name": "John",
                "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
            }
        }
    ]
}