GET/boards/{boardId}/posts

게시판의 게시글 목록을 조회한다.
권한이 있는 게시판의 게시글만 조회할 수 있다

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

board
board.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
boardId integer 

게시판 ID


required
example : 100
format : int64 

Query Parameters

ParameterTypeDescription
count integer 

목록 조회 개수


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

다음 목록 조회 시 사용하는 값


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 

게시판 번호


format : int64 
postId integer 

게시글 번호


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}