GET/boards/{boardId}/posts/{postId}/attachments

投稿に添付されたファイルリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

board
board.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/boards/{boardId}/posts/{postId}/attachments

Path Parameters

ParameterTypeDescription
boardId integer 

掲示板 ID


required
example : 100
format : int64 
postId integer 

投稿 ID


required
example : 1
format : int64 

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 20
minimum : 1
maximum : 20
example : 10
format : int32 
cursor string 

次のリストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
attachments array (object) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

object

PropertyTypeDescription
attachmentId string 

ファイル ID


required
readOnly : true 
fileName string 

ファイル名


required 
fileSize integer 

添付ファイルのサイズ (単位: bytes)


required
format : int64 
createdTime string 

登録日時


required
format : date-time
readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "attachments": [3    {4      "attachmentId": "jp1.1234.5678.1000000000000000001.0.100000000004",5      "fileName": "ExampleFile.pdf",6      "fileSize": 10240000,7      "createdTime": "2022-10-28T17:26:35+09:00"8    }9  ],10  "responseMetaData": {11    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="12  }13}