グループフォルダ

グループフォルダの情報を取得します。 ユーザーが作成したグループフォルダのみ取得できます。

出力には、グループフォルダに属するグループの未確認新着情報の合計件数が含まれます。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET

必須パラメータ

ありません。

オプションパラメータ

  • include-rule-out-notification - 新着情報件数の合計に「通知しない」に設定したグループの件数を含める場合に指定します。値は “true” のみ可能です。 指定しない場合は、「通知しない」に設定したグループの件数は除かれます。
  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。

グループフォルダを取得する

Examples

リクエストの例:

GET /api/groupFolder/V2

レスポンスの例:

<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/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>
    <id>1:5</id>
    <title>仕事</title>
    <author>
      <name>高橋 健太</name>
      <uri>1:1</uri>
    </author>
    <cblNtf:unconfirmedCount>5</cblNtf:unconfirmedCount>
  </entry>
  <entry>
    <id>1:6</id>
    <title>プライベート</title>
    <author>
      <name>高橋 健太</name>
      <uri>1:1</uri>
    </author>
    <cblNtf:unconfirmedCount>3</cblNtf:unconfirmedCount>
  </entry>
</feed> 

エラーコード

ありません。