スペース情報の取得 – cybozu developer network

スペースの情報を取得します。

スペース機能を利用していない場合にはエラーになります。
ゲストスペース機能を利用していない場合にはエラーになります。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/k/v1/space.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/{ゲストスペースのID}/v1/space.json

必要なアクセス権

スペースの閲覧権限

※非公開スペースの場合、スペースメンバーのみ実行可能です。

リクエストパラメータ

パラメータ名	指定する値	必須	説明
id	数値又は文字列	必須	情報を取得するスペースのIDを指定します。

リクエストの例

(1) パラメータを HTTP のクエリ文字列で送信する場合

「id」のパラメータをHTTPのクエリ文字列として送信します。

リクエストヘッダを含んだ文字列

GET /k/v1/space.json?id=1 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

Content-Typeヘッダは不要です。

(2) パラメータを JSON形式で送信する場合（HTTP リクエストのリクエストボディに JSON データをセットする場合）

リクエストヘッダ

GET /k/v1/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 が解釈できないため、実行時エラーとなります。

ボディ

JSON文字列をリクエストボディに載せて送ります。

レスポンス

パラメータ名	値の種類	説明
id	文字列	スペースID。
name	文字列	スペース名。
defaultThread	文字列	スペースが作成されたときに初期作成されたスレッドのID。シングルスレッドスペースの場合はこのスレッドのみ存在します。
isPrivate	真偽値	公開、非公開の区分。 true: 非公開スペース false: 公開スペース
creator	オブジェクト	スペースの作成者情報。
creator.code	文字列	作成者のコード。停止中または削除済みユーザーの場合は空文字列が返ります。
creator.name	文字列	作成者の名前。停止中または削除済みユーザーの場合は空文字列が返ります。
modifier	オブジェクト	スペースの更新者情報。
modifier.code	文字列	更新者のコード。停止中または削除済みユーザーの場合は空文字列が返ります。
modifier.name	文字列	更新者の名前。停止中または削除済みユーザーの場合は空文字列が返ります。
memberCount	文字列	スペースのメンバー数。
coverType	文字列	スペースのカバー画像の種類。 BLOB: アップロードしたファイル PRESET: 組み込み画像
coverKey	文字列	スペースのカバー画像のキー文字列。
coverUrl	文字列	スペースのカバー画像のURL。
body	文字列	スペースの本文（HTML）。
useMultiThread	真偽値	マルチスレッドスペースであるかの判別。 true: マルチスレッドスペース false: シングルスレッドスペース
isGuest	真偽値	ゲストスペースであるかの判別。 true: ゲストスペース false: 通常スペース
attachedApps	配列	スレッド内アプリのリスト。公開前のアプリは含みません。設定完了していない項目も反映されません。
attachedApps[].threadId	文字列	スレッドID。
attachedApps[].appId	文字列	アプリID。
attachedApps[].code	文字列	アプリコード。指定されていない場合は空文字を返します。
attachedApps[].name	文字列	アプリの名前。国際化に対応した結果を返します。
attachedApps[].description	文字列	アプリの説明。国際化対応した結果を返します。
attachedApps[].createdAt	文字列	アプリの作成日時。
attachedApps[].creator	オブジェクト	アプリの作成者情報。
attachedApps[].creator.code	文字列	作成者のコード。停止中または削除済みユーザーの場合は空文字列が返ります。
attachedApps[].creator.name	文字列	作成者の名前。停止中または削除済みユーザーの場合は空文字列が返ります。
attachedApps[].modifiedAt	文字列	アプリの更新日時。
attachedApps[].modifier	オブジェクト	アプリの更新者情報。
attachedApps[].modifier.code	文字列	更新者のコード。停止中または削除済みユーザーの場合は空文字列が返ります。
attachedApps[].modifier.name	文字列	更新者の名前。停止中または削除済みユーザーの場合は空文字列が返ります。
fixedMember	真偽値	各ユーザーがスペースの退会/アンフォローすることを禁止するかの判別。 true: 禁止する false: 禁止しない