GET/boards/must/posts

Gets a list of must-read posts.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

board
board.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
count integer 

Number of items in a list


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

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
posts array (object) 
 
responseMetaData object (responseMetaData) 

Metadata for pagination

 

object

PropertyTypeDescription
boardId integer 

Board no.


format : int64 
postId integer 

Post no.


format : int64 
title string 

Subject


required 
readCount integer 

Number of reads


format : int64 
commentCount integer 

Number of comments


format : int64 
fileCount integer 

Number of files


format : int64 
createdTime string 

Creation time

  • Format: YYYY-MM-DDThh:mm:ssTZD

required
format : date-time
readOnly : true 
modifiedTime string 

Update time

  • Format: YYYY-MM-DDThh:mm:ssTZD

format : date-time
readOnly : true 
isMustRead boolean 

Indicates whether the post must be read.

 
mustReadPeriod object (mustReadPeriod) 

Must-read period

 
resourceLocation integer 

Resource location (location code)


format : int32 
isUnread boolean 

Indicates whether the post is unread.

 
userName string 

Author name


readOnly : true 

mustReadPeriod

PropertyTypeDescription
startDate string 

Must-read start date


format : date
readOnly : true 
endDate string 

Must-read end date


format : date 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

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}