kintone APIドキュメント

スペースを作成する

目次

スペースを作成する

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

テンプレートからスペースを作成します。

  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースを作成しようとするとエラーが発生します。

URL

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

https://sample.cybozu.com/k/v1/template/space.json

ゲストスペースを作成する場合でも、上記のURLでAPIを実行してください。

HTTPメソッド

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

POST

必要なアクセス権

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

  • スペース作成権限
    ゲストスペースとして作成する場合、ゲストスペースの作成権限が必要です。

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
id 数値または文字列 必須 作成するスペースのテンプレートID
name 文字列 必須 作成するスペースの名前
members 配列 必須 スペースのメンバーの情報の一覧
スペース管理者を1名以上指定していない場合、もしくは下記ユーザーのいずれかを指定した場合、エラーが発生します。
  • kintoneを利用していないユーザー
  • 使用停止中のユーザー
  • 削除したユーザー
members[].entity オブジェクト 必須 スペースのメンバーの情報
ゲストユーザーは指定できません。
members[].entity.type 文字列 必須 スペースのメンバーの種類
次の値を指定できます。
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
members[].entity.code 文字列 必須 スペースのメンバーのコード
members[].isAdmin 真偽値または文字列 条件必須 メンバーをスペース管理者にするかどうか
  • true：メンバーをスペース管理者にする
  • false：メンバーをスペース管理者にしない
省略すると「false」が設定されます。
スペース管理者を1名以上設定していないと、エラーとなります。
members[].includeSubs 真偽値または文字列 省略可 下位組織を含めるかどうか
  • true：下位組織を含める
  • false：下位組織を含めない
省略すると「false」が設定されます。
entity.typeが「ORGANIZATION」の場合のみ有効です。
isPrivate 真偽値または文字列 省略可 スペースを非公開にするかどうか
  • true：非公開スペース
  • false：公開スペース
省略すると「false」が設定されます。
isGuestが 「true」の場合は 「true」が設定されます。
isGuest 真偽値または文字列 省略可 スペースをゲストスペースとして作成するかどうか
  • true：ゲストスペースとして作成する
  • false：通常のスペースとして作成する
省略すると「false」が設定されます。
ゲストスペースを有効にしていない場合にtrueを指定すると、エラーが発生します。
fixedMember 真偽値または文字列 省略可 各ユーザーにスペースの退会／スレッドのアンフォローを禁止するかどうか
  • true：禁止する
  • false：許可する
省略すると「false」が設定されます。
リクエストの例
ヘッダー
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
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "id": 1,
  "name": "サンプルスペース",
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": true
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 作成されたスペースのスペースID
レスポンスの例
1
2
3

{
  "id": "1"
}

サンプルコード

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

curlを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

curl -X POST 'https://sample.cybozu.com/k/v1/template/space.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1,
    "name": 'サンプルスペース',
    "members": [
      {
        "entity": {
          "type": "USER",
          "code": "user1"
        },
        "isAdmin": true
      },
      {
        "entity": {
          "type": "GROUP",
          "code": "group1"
        },
        "isAdmin": false
      },
      {
        "entity": {
          "type": "ORGANIZATION",
          "code": "org1"
        },
        "isAdmin": false,
        "includeSubs": true
      }
    ]
  }'
kintone.api()を使ったリクエスト

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

const body = {
  id: 1,
  name: 'サンプルスペース',
  members: [
    {
      entity: {
        type: 'USER',
        code: 'user1'
      },
      isAdmin: true
    },
    {
      entity: {
        type: 'GROUP',
        code: 'group1'
      },
      isAdmin: false
    },
    {
      entity: {
        type: 'ORGANIZATION',
        code: 'org1'
      },
      isAdmin: false,
      includeSubs: true
    }
  ]
};

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