POST/boards/{boardId}/posts/{postId}/comments

コメントを登録する。登録の際、投稿の作成者に通知される。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

board

HTTP Request

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

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 

Request Body

OK

PropertyTypeDescription
content string 

内容


required
minLength : 1
maxLength : 5000 

Request Example

example

1{2  "content": "Example content"3}

Response

HTTP 201

OK

PropertyTypeDescription
boardId integer 

掲示板 ID


required
format : int64
readOnly : true 
postId integer 

投稿 ID


required
format : int64
readOnly : true 
commentId integer 

コメント ID


required
format : int64
readOnly : true 
content string 

内容


required 
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 
userId string 

登録者 ID
削除されたアカウントは空白で表示される。


readOnly : true
nullable : true 
userName string 

登録者名


required
readOnly : true 
hasReply boolean 

返信フラグ


default : false
readOnly : true 
hasAttachment boolean 

添付ファイルフラグ


default : false
readOnly : true 
isDeleted boolean 

削除フラグ


default : false
readOnly : true 

Response Example

example

1{2  "boardId": 100,3  "postId": 1,4  "commentId": 1,5  "content": "Example content",6  "createdTime": "2022-10-28T17:26:35+09:00",7  "modifiedTime": "2022-10-28T17:26:35+09:00",8  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",9  "userName": "Susan Nielsen",10  "hasReply": false,11  "hasAttachment": false,12  "isDeleted": false13}

HTTP 403

Forbidden