スペースの作成
テンプレートからスペースを作成します。
- スペース機能を利用していない場合にはエラーになります。
- ゲストスペース機能を利用していない場合にはエラーになります。
HTTP メソッド
POST
URI
https://(サブドメイン名).cybozu.com/k/v1/template/space.json
作成するスペースがゲストスペースの場合でも、同様に上記の URL にリクエストを送信してください。
必要なアクセス権
スペース作成権限
※ゲストスペースとして作成する場合、ゲストスペースの作成権限が必要です。
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
id | 数値又は文字列 | 必須 | 作成するスペースのテンプレート ID を指定します。 |
name | 文字列 | 必須 | 作成するスペースの名前を指定します。 |
members | 配列 | 必須 |
スペースのメンバーの情報を配列として指定します。
|
members[].entity | オブジェクト | 必須 | スペースのメンバーのエンティティ情報です。 ゲストユーザーは指定できません。 |
members[].entity.type | 文字列 | 必須 | スペースのメンバーのエンティティの種類です。 USER、GROUP、ORGANIZATIONの中から指定します。 |
members[].entity.code | 文字列 | 必須 | スペースのメンバーのエンティティのコードです。 |
members[].isAdmin | 真偽値又は文字列 | 条件必須 |
メンバーをスペース管理者にするか指定します。省略時はfalseとなります。 ※スペース管理者を1名以上含まない場合、エラーとなります。 |
members[].includeSubs | 真偽値又は文字列 | 下位組織を含めるか指定します。entityのtypeがORGANIZATIONの場合のみ有効です。省略時はfalseとなります。 true: 下位組織を含める。 false: 下位組織を含めない。 |
|
isPrivate | 真偽値又は文字列 | 非公開スペースか指定します。省略時はfalseとなります。 true: 非公開スペース false: 公開スペース ※isGuestがtrueの場合は常にtrueが指定されます。 |
|
isGuest | 真偽値又は文字列 | スペースをゲストスペースとして作成するか指定します。省略時はfalseとなります。 true: ゲストスペースとして作成 false: 通常のスペースとして作成 ※ゲストスペースの利用がOFFの場合にはエラーになります。 |
|
fixedMember | 真偽値又は文字列 |
各ユーザーにスペースの退会/スレッドのアンフォローを禁止するかどうか指定します。省略時はfalseとなります。
true: 禁止する false: 許可する |
リクエストの例
HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。
リクエストヘッダ
POST /k/v1/template/space.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 が解釈できないため、実行時エラーとなります。
レスポンス
パラメータ名 | 値の種類 | 説明 |
---|---|---|
id | 文字列 | 作成されたスペースのID |
JavaScriptサンプル
XMLHttpRequest
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。