ファイル(グループ)

グループの共有フォルダのファイル情報を取得するための API です。

リクエスト

エンドポイント

  • https://api.cybozulive.com/api/gwCabinet/V2

利用可能な HTTP メソッド

GET

リクエスト制限

ありません。

指定グループのファイルを取得する

グループの ID を指定して、ファイルを取得します。

必須パラメータ

  • group - グループの ID を指定します。
  • cabinet-folder - 絞り込むフォルダを指定します。値はID文字列を指定するか、”UNCLASSIFIED” で未分類、”ATTACH” で添付、”TRASH” でごみ箱を指定します。

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • embed-history - “true” の場合、ファイル履歴情報を取得します。ファイル履歴情報は最新のものから最大で5件取得します。

レスポンス

要素 説明
/feed/entry/cblCbnt:fileName ファイル名。
/feed/entry/cblCbnt:fileSize ファイルサイズ。
/feed/entry/cblCbnt:imageFileWidth 画像ファイルの幅。 (画像ファイルのみで出力)
/feed/entry/cblCbnt:imageFileHeight 画像ファイルの高さ。 (画像ファイルのみで出力)
/feed/entry/cblCbnt:thumbnailExists サムネイル画像が存在するかどうか。
/feed/entry/cblCbnt:folder フォルダ。
/feed/entry/cblCbnt:versionNumber バージョン番号。
/feed/entry/cbl:group グループ。
/feed/entry/cblCbnt:histories/cbl:feedLink ファイル履歴情報。

Examples

リクエストの例:

GET /api/gwCabinet/V2?group=1:1&cabinet-folder=1:5

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblCbnt="http://schemas.cybozulive.com/cabinet/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-07-29T02:39:46Z</updated>
  <dc:date>2010-07-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>タイトル。指定なしの場合はファイル名</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwCabinet/view?cid=1%3A1" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwCabinet/modify?cid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwCabinet/view?cid=1%3A1" />
    <category term="GROUP" />
    <category term="CABINET" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,CABINET,1:1</id>
    <summary type="text">メモ</summary>
    <cblCbnt:fileName>ファイル名.jpg</cblCbnt:fileName>
    <cblCbnt:fileSize>515072</cblCbnt:fileSize>
    <cblCbnt:imageFileWidth>800</cblCbnt:imageFileWidth>
    <cblCbnt:imageFileHeight>600</cblCbnt:imageFileHeight>
    <cblCbnt:thumbnailExists>true</cblCbnt:thumbnailExists>
    <cblCbnt:folder valueString="お知らせ" id="1:5" />
    <cblCbnt:versionNumber>3</cblCbnt:versionNumber>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:confirmed>true</cbl:confirmed>
  </entry>
  <entry>
    <title>タイトル。指定なしの場合はファイル名</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwCabinet/view?cid=1%3A10" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwCabinet/modify?cid=1%3A10" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwCabinet/view?cid=1%3A10" />
    <category term="GROUP" />
    <category term="CABINET" />
    <author>
      <name>brown</name>
      <uri>2:8</uri>
    </author>
    <id>GROUP,1:1,CABINET,1:10</id>
    <summary type="text"></summary>
    <cblCbnt:fileName>ファイル名.txt</cblCbnt:fileName>
    <cblCbnt:fileSize>10240</cblCbnt:fileSize>
    <cblCbnt:thumbnailExists>false</cblCbnt:thumbnailExists>
    <cblCbnt:versionNumber>5</cblCbnt:versionNumber>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
</feed>

特定のファイルを取得する

ID を指定して、ファイルを取得します。

必須パラメータ

  • entry - ファイル ID を指定します。

オプションパラメータ

  • embed-history - “true” の場合、ファイル履歴情報を取得します。ファイル履歴情報は最新のものから最大で5件取得します。

レスポンス

グループ ID を指定した場合と同様の形式のレスポンスを返します。

Examples

リクエストの例:

GET /api/gwCabinet/V2?entry=GROUP,1:1,CABINET,1:5

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblCbnt="http://schemas.cybozulive.com/cabinet/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2015-07-29T02:39:46Z</updated>
  <dc:date>2015-07-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>花火大会のお知らせ</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwCabinet/view?cid=1%3A5" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwCabinet/modify?cid=1%3A5" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwCabinet/view?cid=1%3A5" />
    <category term="GROUP" />
    <category term="CABINET" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,CABINET,1:5</id>
    <summary type="text">会場案内</summary>
    <cblCbnt:fileName>花火大会.pdf</cblCbnt:fileName>
    <cblCbnt:fileSize>515072</cblCbnt:fileSize>
    <cblCbnt:thumbnailExists>false</cblCbnt:thumbnailExists>
    <cblCbnt:folder valueString="お知らせ" id="1:5" />
    <cblCbnt:versionNumber>3</cblCbnt:versionNumber>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:confirmed>true</cbl:confirmed>
  </entry>
</feed>

ファイル履歴情報を取得する

Examples

リクエストの例:

GET /api/gwCabinet/V2?group=1:1&cabinet-folder=1:5&embed-history=true

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblCbnt="http://schemas.cybozulive.com/cabinet/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2015-07-31T02:39:46Z</updated>
  <dc:date>2015-07-31T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>タイトル。指定なしの場合はファイル名</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwCabinet/view?cid=1%3A1" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwCabinet/modify?cid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwCabinet/view?cid=1%3A1" />
    <category term="GROUP" />
    <category term="CABINET" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,CABINET,1:1</id>
    <summary type="text">メモ</summary>
    <cblCbnt:fileName>ファイル名</cblCbnt:fileName>
    <cblCbnt:fileSize>515072</cblCbnt:fileSize>
    <cblCbnt:thumbnailExists>false</cblCbnt:thumbnailExists>
    <cblCbnt:folder valueString="お知らせ" id="1:5" />
    <cblCbnt:versionNumber>10</cblCbnt:versionNumber>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:confirmed>true</cbl:confirmed>
    <cblCbnt:histories>
      <cbl:feedLink>
        <feed>
          <entry>
            <cblCbnt:versionNumber>10</cblCbnt:versionNumber>
            <cblCbnt:fileName>お知らせ.txt</cblCbnt:fileName>
            <updated>2015-07-30T07:41:51Z</updated>
            <author>
              <name>田中 美子</name>
              <uri>1:11</uri>
            </author>
          </entry>
          <entry>
            <cblCbnt:versionNumber>9</cblCbnt:versionNumber>
            <cblCbnt:fileName>お知らせ.txt</cblCbnt:fileName>
            <updated>2015-07-30T07:20:00Z</updated>
            <author>
              <name>田中 美子</name>
              <uri>1:11</uri>
            </author>
            <summary type="text">変更時のコメント</summary>
          </entry>
          <entry>
            <cblCbnt:versionNumber>8</cblCbnt:versionNumber>
            <cblCbnt:fileName>お知らせ.txt</cblCbnt:fileName>
            <updated>2015-07-30T06:58:15Z</updated>
            <author>
              <name>田中 美子</name>
              <uri>1:11</uri>
            </author>
            <summary type="text">変更時のコメント</summary>
          </entry>
          <entry>
            <cblCbnt:versionNumber>7</cblCbnt:versionNumber>
            <cblCbnt:fileName>お知らせ.txt</cblCbnt:fileName>
            <updated>2015-07-30T06:58:12Z</updated>
            <author>
              <name>田中 美子</name>
              <uri>1:11</uri>
            </author>
            <summary type="text">変更時のコメント</summary>
          </entry>
          <entry>
            <cblCbnt:versionNumber>6</cblCbnt:versionNumber>
            <cblCbnt:fileName>お知らせ.txt</cblCbnt:fileName>
            <updated>2015-07-30T06:55:12Z</updated>
            <author>
              <name>田中 美子</name>
              <uri>1:11</uri>
            </author>
            <summary type="text">変更時のコメント</summary>
          </entry>
        </feed>
      </cbl:feedLink>
    </cblCbnt:histories>

  </entry>
</feed>

エラーコード

ありません。