PUT/boards/{boardId}

게시판을 수정한다.
게시판 관리자 권한이 있어야 한다.
게시판 권한, 관리자 목록, 타입, 템플릿은 수정할 수 없다.

Authorization

oauth2

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

Scope

board

HTTP Request

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

Path Parameters

ParameterTypeDescription
boardId integer 

게시판 ID


required
example : 100
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
boardName string 

제목


required
minLength : 1
maxLength : 60 
description string 

설명


maxLength : 300 

Request Example

example

1{2  "boardName": "Notice",3  "description": "Notice Description"4}

Response

HTTP 200

OK

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 

Response Example

example

1{2  "boardId": 100,3  "boardName": "Notice",4  "description": "Notice Description",5  "createdTime": "2022-10-28T17:26:35+09:00",6  "modifiedTime": "2022-10-28T17:26:35+09:00",7  "displayOrder": 18}

HTTP 307

Temporary Redirect
타 인스턴스에 존재하는 리소스
location 헤더에 요청에 해당하는 URL을 반환한다

HTTP 403

Forbidden