掲示板作成

    掲示板やカテゴリーを作成します。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/home/v1/boards

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Request

    requestBodyに次の値を渡します。

    パラメーター タイプ 必須 説明
    domainId Integer Y ドメイン ID
    title String Y 掲示板名 / カテゴリー名(最長:60bytes) 
    description String N 説明(最長:300bytes)
    boardType String N 掲示板のタイプ
    • BOARD: 掲示板(既定値)
    • GROUP_TITLE: カテゴリー

    Request Example

    https://apis.worksmobile.com/r/{API ID}/home/v1/boards
    Content-Type: application/json
    
    {
      "domainId": "{{domainId}}",
      "title": "Home Board1",
      "description": "Welcome",
      "boardType": "BOARD"
    }
    

    Response

     プロパティ  タイプ 必須 説明
    boardNo Long Y 掲示板の番号 

    Response Example

    {
        "boardNo": 123123
    }
    

    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
    }