GET/boards

권한에 따른 게시판 목록을 조회한다.
카테고리는 조회되지 않는다.
쓰기 권한으로 조회 시, 게시판에 읽기 권한이 없으면 조회되지 않는다.

Authorization

oauth2

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

Scope

board
board.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
role string 

게시판 권한
READER - 게시글 읽기 권한이 있는 게시판 목록 조회
WRITER - 게시글 쓰기 권한이 있는 게시판 목록 조회


default : READER
Allowed values : READER, WRITER
example : WRITER 
count integer 

목록 조회 개수


default : 100
minimum : 1
maximum : 200
example : 200
format : int32 
cursor string 

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
boards array (object) 
 
responseMetaData object (responseMetaData) 

페이징 처리를 위한 메타데이터

 

object

PropertyTypeDescription
boardId integer 

게시판 번호


required
format : int64 
boardName string 

제목


required 
description string 

설명

 
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 
displayOrder integer 

게시판 순서


required
format : int32
readOnly : true 
resourceLocation integer 

해당 리소스 위치(지역 코드)


format : int32 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 페이지 조회를 위한 커서

 

Response Example

example

1{2  "boards": [3    {4      "boardId": 100,5      "boardName": "Notice",6      "description": "Notice Description",7      "createdTime": "2019-08-24T14:15:22+09:00",8      "modifiedTime": "2022-10-28T17:26:35+09:00",9      "displayOrder": 1,10      "resourceLocation": 2410111    }12  ],13  "responseMetaData": {14    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="15  }16}