PUT/boards/{boardId}

掲示板を更新する。

  • 掲示板の管理者権限が必要。権限は、[管理者画面 > セキュリティ > 管理者権限] で設定する。
  • 掲示板の権限、管理者リスト、タイプ、テンプレートは更新できない。

Authorization

oauth2

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

Scope

board

HTTP Request

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

Path Parameters

ParameterTypeDescription
boardId integer 

掲示板 ID


required
example : 100
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
boardName string 

掲示板名


required
minLength : 1
maxLength : 60 
description string 

掲示板の説明


maxLength : 300 

Request Example

example

1{2  "boardName": "Notice",3  "description": "Notice Description"4}

Response

HTTP 200

OK

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 

Response Example

example

1{2  "boardId": 100,3  "boardName": "Notice",4  "description": "Notice Description",5  "createdTime": "2022-10-28T17:26:35+09:00",6  "modifiedTime": "2022-10-28T17:26:35+09:00",7  "displayOrder": 18}

HTTP 307

Temporary Redirect - 他のインスタンスに存在するリソース。Location ヘッダーのダウンロード URL にリダイレクト。

HTTP 403

Forbidden