kintone APIドキュメント

スペースの設定を変更する

目次

スペースの設定を変更する

固定リンクがコピーされました

スペースの設定を変更します。

URL

固定リンクがコピーされました

通常のスペース
https://sample.cybozu.com/k/v1/space.json
ゲストスペース
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space.json

HTTPメソッド

固定リンクがコピーされました

PUT

必要なアクセス権

固定リンクがコピーされました

  • スペース管理権限

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
id 数値または文字列 必須 スペースID
name 文字列 省略可 スペース名
指定されていない場合は更新しない。
isPrivate 真偽値 省略可 非公開スペースに更新するかどうか
  • true：非公開スペース
  • false：公開スペース

指定されていない場合は更新しない。
fixedMember 真偽値 省略可 各ユーザーがスペースの退会／アンフォローすることを禁止するかどうか
  • true：禁止する
  • false：禁止しない

指定されていない場合は更新しない。
useMultiThread 真偽値 省略可 マルチスレッドスペースに更新するかどうか
  • true：マルチスレッドスペース

falseまたは、指定されていない場合は更新しない。
showAnnouncement 真偽値 省略可 マルチスレッドスペースのポータルの「お知らせ」を表示するかどうか
  • true：表示する
  • false：表示しない
showThreadList 真偽値 省略可 マルチスレッドスペースのポータルの「スレッド一覧」を表示するかどうか
  • true：表示する
  • false：表示しない
showAppList 真偽値 省略可 マルチスレッドスペースのポータルの「アプリ一覧」を表示するかどうか
  • true：表示する
  • false：表示しない
showMemberList 真偽値 省略可 マルチスレッドスペースのポータルの「ピープル一覧」を表示するかどうか
  • true：表示する
  • false：表示しない
showRelatedLinkList 真偽値 省略可 マルチスレッドスペースのポータルの「関連リンク一覧」を表示するかどうか
  • true：表示する
  • false：表示しない
permissions オブジェクト 省略可 スペースに関する権限
permissions.createApp 文字列 省略可 アプリを作成できるユーザー
  • EVERYONE：すべてのユーザー
  • ADMIN：スペースの管理者

指定されていない場合は更新しない。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "id": 123,
  "name": "スペース名",
  "isPrivate": true,
  "fixedMember": true,
  "useMultiThread": true,
  "showAnnouncement": true,
  "showThreadList": true,
  "showAppList": true,
  "showMemberList": true,
  "showRelatedLinkList": true,
  "permissions": {
    "createApp": "EVERYONE"
  }
}

レスポンス

固定リンクがコピーされました

1

{}

サンプル

固定リンクがコピーされました

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

curl -X PUT 'https://sample.cybozu.com/k/v1/space.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 123,
    "name": "スペース名",
    "isPrivate": true,
    "fixedMember": true,
    "useMultiThread": true,
    "showAnnouncement": true,
    "showThreadList": true,
    "showAppList": true,
    "showMemberList": true,
    "showRelatedLinkList": true,
    "permissions": {
      "createApp": "EVERYONE"
    }
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

const body = {
  id: 123,
  name: スペース名,
  isPrivate: true,
  fixedMember: true,
  useMultiThread: true,
  showAnnouncement: true,
  showThreadList: true,
  showAppList: true,
  showMemberList: true,
  showRelatedLinkList: true,
  permissions: {
    createApp: 'EVERYONE'
  }
};

await kintone.api(kintone.api.url('/k/v1/space.json', true), 'PUT', body);