掲示板リストの照会
ドメインの掲示板リストを照会します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/home/v1/boards
HTTP Method
GET(Content-Type: Application/x-www-form-urlencode; charset=UTF-8)
Request
query parameter
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
domainId | Integer | Y | 照会するドメイン |
Request Example
https://apis.worksmobile.com/r/{API ID}/home/v1/boards?domainId=123123
Response
API 呼び出しに成功すると、結果を "boards" リストで返します。
プロパティ | タイプ | 必須 | 説明 |
---|---|---|---|
boards | List |
Y | 掲示板リスト |
Board
プロパティ | タイプ | 必須 | 説明 |
---|---|---|---|
boardNo | Long | Y | 掲示板の番号 |
title | String | Y | 掲示板名/カテゴリー名 |
description | String | Y | 掲示板の説明 |
boardType | String | Y | 掲示板のタイプ • BOARD: 掲示板(既定値) • GROUP_TITLE: カテゴリー |
registerUtcDate | Long | Y | 作成日(単位: timestamp in millisecond) |
modifyUtcDate | Long | Y | 修正日(単位: timestamp in millisecond) |
order | Integer | Y | 掲示板の並び順 |
resourceDomainId | String | N | 掲示板が所属するドメイン ID。resourceDomainId が指定されている掲示板に投稿やコメントするには、resourceDomainId のドメインの Token に切り替えて API をコールする必要があります。 • 指定なし- 現在のドメインに所属する掲示板 • 指定あり - 他のドメインに所属する掲示板 |
Response Example
{
"boards": [
...
{
"title": "Group1",
"description": "グループ会社が一緒に使用するグループ会社のグループ掲示板",
"registerUtcDate": 1527499669868,
"modifyUtcDate": 1528616168301,
"order": 92,
"boardNo": 46288800516,
"boardType": "BOARD"
},
{
"title": "Group2",
"description": "グループ会社が一緒に使用するグループ会社のグループ掲示板2",
"registerUtcDate": 1527499669869,
"modifyUtcDate": 1528616168302,
"order": 93,
"boardNo": 46288800517,
"boardType": "BOARD",
"resourceDomainId": "12345"
}
]
}
API呼び出しに失敗した場合、HTTP status codeでエラーを返します。
HTTP status code | error | message | 説明 |
---|---|---|---|
400 | Bad Request | Invalid Parameter | 不正なパラメーター |
HTTP/1.1 400
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Tue, 07 May 2019 07:44:09 GMT
Connection: close
{
"error": "Bad Request",
"message": "Invalid parameter",
"status": 400
}