PUT/boards/{boardId}/posts/{postId}

게시글을 수정한다
보안상 HTML Script는 사용할 수 없다.

Authorization

oauth2

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

Scope

board

HTTP Request

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

Path Parameters

ParameterTypeDescription
boardId integer 

게시판 ID


required
example : 100
format : int64 
postId integer 

게시글 ID


required
example : 1
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
title string 

제목


required
minLength : 1
maxLength : 200 
body string 

내용


required
minLength : 1
maxLength : 716800 
enableComment boolean 

댓글 사용 여부


default : true 
mustReadEndDate string 

필독 종료일(최대 30일)


format : date 
sendNotifications boolean 

게시글 생성 알림 발송 여부


default : true 

Request Example

example

1{2  "title": "Example title",3  "body": "<h1>Example</h1> Insert body here.",4  "enableComment": true,5  "mustReadEndDate": "2023-03-20",6  "sendNotifications": true7}

Response

HTTP 200

OK

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) 

필독 기간

 
body string 

내용(형식: HTML)


required 
enableComment boolean 

댓글 사용 여부

 
userId string 

readOnly : true
nullable : true 
userName string 

작성자 이름


readOnly : true 

mustReadPeriod

PropertyTypeDescription
startDate string 

필독 시작일


format : date
readOnly : true 
endDate string 

필독 종료일


format : date 

Response Example

example

1{2  "boardId": 100,3  "postId": 1,4  "title": "Example title",5  "readCount": 0,6  "commentCount": 0,7  "fileCount": 0,8  "createdTime": "2022-10-28T17:26:35+09:00",9  "modifiedTime": "2022-10-28T17:26:35+09:00",10  "isMustRead": true,11  "mustReadPeriod": {12    "startDate": "2023-03-13",13    "endDate": "2023-03-20"14  },15  "body": "<h1>Example</h1> Insert body here.",16  "enableComment": true,17  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",18  "userName": "Susan Nielsen"19}

HTTP 307

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

HTTP 403

Forbidden