検索
Close
カテゴリー内の他の記事

スペース情報の取得

作成日
更新日

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

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

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。 1つのスレッドのみ使用するスペースの場合はこのスレッドのみ存在します。
isPrivate 真偽値 公開、非公開の区分。
true: 非公開スペース
false: 公開スペース
creator オブジェクト スペースの作成者情報。
creator.code 文字列 作成者のコード。停止中または削除済みユーザーの場合は空文字列が返されます。
creator.name 文字列 作成者の名前。停止中または削除済みユーザーの場合は空文字列が返されます。
modifier オブジェクト スペースの更新者情報。
modifier.code 文字列 更新者のコード。停止中または削除済みユーザーの場合は空文字列が返されます。
modifier.name 文字列 更新者の名前。停止中または削除済みユーザーの場合は空文字列が返されます。
memberCount 文字列 スペースのメンバー数。
coverType 文字列 スペースのカバー画像の種類。 BLOB: アップロードしたファイル PRESET: 組み込み画像
coverKey 文字列 スペースのカバー画像のキー文字列。
coverUrl 文字列 スペースのカバー画像のURL。
body 文字列 スペースの本文（HTML）。
スペース本文のHTMLが空の場合nullが返されます。
ただし、一度でも本文を設定したことがあるスペースの場合、画面上では何も表示されていなくても、HTMLタグのみが設定されている可能性があります。その場合それらの文字列が返されます。
useMultiThread 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースであるかの判別。
true: 「スペースのポータルと複数のスレッドを使用する」が有効のスペース
false: 1つのスレッドのみ使用するスペース
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: 禁止しない
showAnnouncement 真偽値
「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「お知らせ」の表示状態。
true: 表示する
false: 表示しない
※ 1つのスレッドのみ使用するスペース・ゲストスペースでは null
showThreadList
 真偽値
「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「スレッド一覧」の表示状態。
true: 表示する
false: 表示しない
※ 1つのスレッドのみ使用するスペース・ゲストスペースでは null
showAppList 真偽値
「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「アプリ一覧」の表示状態。
true: 表示する
false: 表示しない
※ 1つのスレッドのみ使用するスペース・ゲストスペースでは null
showMemberList 真偽値
「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「ピープル一覧」の表示状態。
true: 表示する
false: 表示しない
※ 1つのスレッドのみ使用するスペース・ゲストスペースでは null
showRelatedLinkList 真偽値
「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「関連リンク一覧」の表示状態。
true: 表示する
false: 表示しない
※ 1つのスレッドのみ使用するスペース・ゲストスペースでは null

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
Sugawara Genki

些細な指摘で恐縮なのですがレスポンス例の"isGuest": falseの末尾にカンマがないようです。

Avatar
cybozu development team

Sugawara Genki 様

ご指摘いただき誠にありがとうございます。
"isGuest": false の末尾にカンマを追記いたしました。

今後とも cybozu.com developer network をよろしくお願い申し上げます。

Avatar
Masayuki Ishikawa

スペース一覧を取得するspaces APIはないのでしょうか？

いまappsを取得してspaceIdを見てからspace APIを叩いています。

Avatar
cybozu Development team

Masayuki Ishikawa 様

お世話になっております。developer network 運営チームです。

現在、スペース一覧を取得するAPIや、スペースIDを指定せず一度にスペース情報を取得できるようなAPIはございません。
ご希望に添えず申し訳ございません。

今後ともよろしくお願いいたします。

Avatar
masano

レスポンスパラメータの

body文字列スペースの本文（HTML）

ですが、特に記述はありませんが、nullで帰ってくることが有りました。

もしnullで渡される可能性のあるものが他にもあれば明記して頂ければありがたいです。

 

レスポンス例ですが、

"showAnnouncement": true,
"showThreadList": true,
"showAppList": true,
"showMemberList": true,
"showRelatedLinkList": true,


がattachedApps[] に入ってしまっています。

"memberCount": 10,

は実際は"10"で帰ってきました。

 

 

Avatar
cybozu Development team

masano様

お世話になっております。cybozu developer network運営事務局です。

ドキュメントに不足、誤記があり大変申し訳ございません。

レスポンスパラメータの body が null で返されることがある点について、レスポンスパラメータの説明に追記しました。

body の他に null で返されることのあるパラメータは、以前より記載しておりました以下の５つのみです。

  • showAnnouncement
  • showThreadList
  • showAppList
  • showMemberList
  • showRelatedLinkList

レスポンス例のご指摘箇所についても修正いたしました。

この度はご指摘いただきありがとうございます。
今後ともよろしくお願いいたします。

サインインしてコメントを残してください。