スペースの本文を更新します。
- スペース機能を利用していない場合にはエラーになります。
- ゲストスペース機能を利用していない場合にはエラーになります。
- マルチスレッドスペースの本文のみ更新できます。 シングルスレッドスペースの本文を更新するときは、スペースのスレッド更新APIをご利用ください。
HTTP メソッド
PUT
URI
https://(サブドメイン名).cybozu.com/k/v1/space/body.json
ゲストスペース内のアプリの場合
https://(サブドメイン名).cybozu.com/k/guest/<ゲストスペースのID>/v1/space/body.json
必要なアクセス権
スペース管理者
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| id | 数値又は文字列 | 必須 | 本文を更新するスペースのIDを指定します。 |
| body | 文字列 | 必須 | 本文をHTML文字列で記述します。許可されていないタグ、属性は保存時に削除されます。 アプリ貼り付け、ファイル添付、絵文字はHTMLを記述すれば可能です。 宛先指定はHTMLで指定しても通知は飛びません。 |
リクエストの例
HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。
リクエストヘッダ
PUT /k/v1/space/body.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
レスポンス
処理成功時は空の JSON データが返されます
JavaScriptサンプル
XMLHttpRequest
スペースの本文を更新と取得を行いたいのですが、シングルスレッドスペースで本文を取得する手段はないでしょうか？
シングルスレッドスペースの本文更新は、スレッド更新APIからできたのですが取得する手段を探しているのですが見つかりませんでした。
スペース情報の取得のAPIも試してみたのですが、シングルスレッドスペースの場合はbodyはnullで返ってくる仕様の様ですね。
{"id": "20",
"name": "スペース更新・取得",
"defaultThread": "21",
"isPrivate": false,
＜省略＞
"body": null,
"useMultiThread": false,
"isGuest": false,
"fixedMember": false,
"attachedApps": []
}
スペース情報の取得とスペース本文の更新APIのbodyというパラメータはそれぞれ、マルチスレッドスペースにおける「お知らせ」欄に対応していると理解しました。
運用としてはマルチスレッドスペースを有効にすることで、要件は満たせそうなのですが、kintoneの既定の設定ではシングルスレッドスペースですのでそちらでも同じ様に使えるといいのですが。
また、ポータル自体のお知らせの本文も取得・更新する手段も探しています。そちらの方が需要は高そうです。