GET/boards

権限に応じた掲示板リストを取得する。

  • カテゴリは取得できない。
  • 書き込み権限で取得した場合、掲示板の読み取り権限がなければ取得できない。

Authorization

oauth2

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

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 

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


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 

掲示板 ID


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}