GET/boards/must/posts

必読投稿リストを取得する。

Authorization

oauth2

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

Scope

board
board.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/boards/must/posts

Query Parameters

ParameterTypeDescription
count integer 

取得数


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

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
posts array (object) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

object

PropertyTypeDescription
boardId integer 

掲示板 ID


format : int64 
postId integer 

投稿 ID


format : int64 
title string 

件名


required 
readCount integer 

既読数


format : int64 
commentCount integer 

コメント数


format : int64 
fileCount integer 

ファイル数


format : int64 
createdTime string 

登録日時 (YYYY-MM-DDThh:mm:ssTZD)


required
format : date-time
readOnly : true 
modifiedTime string 

更新日時 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 
isMustRead boolean 

必読フラグ

 
mustReadPeriod object (mustReadPeriod) 

必読期間

 
resourceLocation integer 

当該リソースの位置 (地域コード)


format : int32 
isUnread boolean 

未読の可否

 
userName string 

登録者名


readOnly : true 

mustReadPeriod

PropertyTypeDescription
startDate string 

必読開始日


format : date
readOnly : true 
endDate string 

必読終了日


format : date 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "posts": [3    {4      "boardId": 100,5      "postId": 1,6      "title": "Notice",7      "readCount": 14,8      "commentCount": 1,9      "fileCount": 0,10      "createdTime": "2022-10-28T17:26:35+09:00",11      "modifiedTime": "2022-10-28T17:26:35+09:00",12      "isMustRead": true,13      "mustReadPeriod": {14        "startDate": "2023-03-13",15        "endDate": "2023-03-20"16      },17      "resourceLocation": 24101,18      "isUnread": true,19      "userName": "Susan Nielsen"20    }21  ],22  "responseMetaData": {23    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="24  }25}