グループ情報

グループの情報を取得します。 ユーザーが所属しているグループの情報のみ取得できます。 取得できる情報には、イベントの予定メニュー名、設備の設備名、ToDoリストのステータス名などがあります。

出力には、グループの未確認新着情報の件数が含まれます。

リクエスト

エンドポイント

https://api.cybozulive.com/api/group/V2

利用可能な HTTP メソッド

GET

必須パラメータ

ありません。

オプションパラメータ

  • start-index - グループ情報を取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - グループ情報を取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • sort-key - グループ情報を取得する場合のソート項目を指定します。値は “USER_SPECIFIED” または “GROUP_MODIFIED” が可能です。デフォルトは “USER_SPECIFIED” です。
  • sort-order - グループ情報を取得する場合のソート順を指定します。値は “ASCENDING” または “DESCENDING” が可能です。デフォルトは “ASCENDING” です。
  • group-folder - 絞り込むグループフォルダを指定します。値はID文字列を指定します。 “UNCLASSIFIED” を指定すると、グループフォルダに入っていないグループのみを取得できます。
  • include-rule-out - “true” の場合に個人設定の参加グループで「通知しない」設定をしたグループを含めます。デフォルトは “true” です。
  • group - 取得するグループを指定します。このパラメータを指定した場合、他のパラメータは無視します。
  • sort-notify - 通知する設定のグループから順に取得します。sort-notify を指定したときは、sort-keysort-orderinclude-rule-out の指定は無視します。

グループの情報を取得する

Examples

リクエストの例:

GET /api/group/V2

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblGrp="http://schemas.cybozulive.com/group/2010"
      xmlns:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:1</uri>
  </author>
  <cbl:totalCount>2</cbl:totalCount>
  <entry>
    <title>開発グループ</title>
    <link rel="alternate" href="https://cybozulive.com/1_21/top/top" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_21/gwTop/top" />
    <category term="GROUP"/>
    <author>
      <name>佐藤 昇</name>
    </author>
    <id>GROUP,1:21</id>
    <summary type="text">グループの概要です。</summary>
    <published>2010-07-12T02:38:52Z</published>
    <dc:creator>佐藤 昇</dc:creator>
    <dc:date>2010-07-12T02:38:52Z</dc:date>
    <cbl:facility valueString="大会議室" id="1:1" group="1:21" groupName="開発グループ" />
    <cbl:facility valueString="応接間" id="1:3" group="1:21" groupName="開発グループ" />
    <cbl:task valueString="保留" id="1:15" group="1:21" groupName="開発グループ" />
    <cbl:task valueString="対応中" id="1:17" group="1:21" groupName="開発グループ" />
    <cblGrp:folder valueString="仕事" id="1:5"/>
    <cblGrp:memberInvitable>true</cblGrp:memberInvitable>
    <cblNtf:unconfirmedCount>3</cblNtf:unconfirmedCount>
    <cblNtf:ruleOut>false</cblNtf:ruleOut>
    <cblGrp:manager>false</cblGrp:manager>
    <cblGrp:invitable authority="false">false</cblGrp:invitable>
    <cblGrp:leavable>true</cblGrp:leavable>
    <cblGrp:deletable authority="false">false</cblGrp:deletable>
  </entry>
  <entry>
    <title>野球部</title>
    <link rel="alternate" href="https://cybozulive.com/1_24/top/top" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_24/gwTop/top" />
    <category term="GROUP"/>
    <author>
      <name>高橋 健太</name>
    </author>
    <id>GROUP,1:24</id>
    <summary type="text"></summary>
    <published>2010-07-12T02:38:52Z</published>
    <dc:creator>高橋 健太</dc:creator>
    <dc:date>2010-07-12T02:38:52Z</dc:date>
    <cbl:facility valueString="河川敷グラウンド" id="1:1" group="1:24" groupName="野球部" />
    <cblGrp:folder valueString="プライベート" id="1:6"/>
    <cblGrp:memberInvitable>false</cblGrp:memberInvitable>
    <cblNtf:unconfirmedCount>10</cblNtf:unconfirmedCount>
    <cblNtf:ruleOut>false</cblNtf:ruleOut>
    <cblGrp:manager>true</cblGrp:manager>
    <cblGrp:invitable authority="true">true</cblGrp:invitable>
    <cblGrp:leavable>false</cblGrp:leavable>
    <cblGrp:deletable authority="true">false</cblGrp:deletable>
  </entry>
</feed>

グループフォルダを指定して、グループの情報を取得する

Examples

リクエストの例:

GET /api/group/V2?group-folder=1:6

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblGrp="http://schemas.cybozulive.com/group/2010"
      xmlns:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:1</uri>
  </author>
  <cbl:totalCount>1</cbl:totalCount>
  <entry>
    <title>野球部</title>
    <link rel="alternate" href="https://cybozulive.com/1_24/top/top" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_24/gwTop/top" />
    <category term="GROUP"/>
    <author>
      <name>高橋 健太</name>
    </author>
    <id>GROUP,1:24</id>
    <summary type="text"></summary>
    <published>2010-07-12T02:38:52Z</published>
    <dc:creator>高橋 健太</dc:creator>
    <dc:date>2010-07-12T02:38:52Z</dc:date>
    <cbl:facility valueString="河川敷グラウンド" id="1:1" group="1:24" groupName="野球部" />
    <cblGrp:folder valueString="プライベート" id="1:6"/>
    <cblGrp:memberInvitable>true</cblGrp:memberInvitable>
    <cblNtf:unconfirmedCount>10</cblNtf:unconfirmedCount>
    <cblNtf:ruleOut>false</cblNtf:ruleOut>
    <cblGrp:manager>true</cblGrp:manager>
    <cblGrp:invitable authority="true">true</cblGrp:invitable>
    <cblGrp:leavable>false</cblGrp:leavable>
    <cblGrp:deletable authority="true">false</cblGrp:deletable>
  </entry>
</feed>