GET/groups/{groupId}/note/posts

組織/グループノートの投稿リストを取得する。
権限がある組織/グループノートの投稿リストのみ取得できる。

Authorization

oauth2

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

Scope

group.note
group.note.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/{groupId}/note/posts

Path Parameters

ParameterTypeDescription
groupId string 

組織/グループ ID


required
example : group127-8545-4463-603b-04d550d23bf 

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 20
minimum : 1
maximum : 40 
cursor string 

リストのカーソル値 (URL エンコードする)


example : sfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
posts array (object) 

投稿リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

object

PropertyTypeDescription
postId integer 

投稿 ID


format : int64 
title string 

件名


required
minLength : 1
maxLength : 200 
enableCollaboration boolean 

他のユーザーの編集許可

 
readCount integer 

既読数


format : int64 
commentCount integer 

コメント数


format : int64 
fileCount integer 

添付ファイル


format : int64 
likeCount integer 

いいねの数


format : int64 
createdTime string 

作成日時


required
format : date-time
readOnly : true 
modifiedTime string 

更新日時


format : date-time
readOnly : true 
userId string 

作成者のユーザー ID
退会済みユーザーの場合には NULL


readOnly : true
nullable : true 
userName string 

作成者の名前


required
readOnly : true 
isNotice boolean 

ノートのお知らせ

 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "posts": [3    {4      "postId": 1,5      "title": "WORKS 利用案内",6      "enableCollaboration": true,7      "readCount": 14,8      "commentCount": 2,9      "fileCount": 0,10      "likeCount": 1,11      "createdTime": "2019-08-24T14:15:22+09:00",12      "modifiedTime": "2019-08-24T14:15:22+09:00",13      "userId": "1bbe7149-0ccd-433d-1eba-04f6901660dc",14      "userName": "Susan Nielsen",15      "isNotice": false16    }17  ],18  "responseMetaData": {19    "nextCursor": "sfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}