ファイルダウンロード

ファイルのバイナリデータを取得するためのAPIです。 現在は画像ファイルのみ対応しています。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET

リクエスト制限

必須パラメータ

  • id - 取得対象の ID を指定します。

オプションパラメータ

  • image-max-size - 画像の最大サイズを指定します。”600” と “100” のみ指定可能です。
  • response-type - 出力形式を指定します。”binary” と “url” のみ指定可能です。デフォルトは “binary” です。

ファイルを取得する

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

Examples

リクエストの例:

GET /api/fileDownload/V2?id=GROUP,1:2,CABINET,1:3
レスポンスの例::
レスポンスヘッダ
Content-Type: image/jpegimage/png など
レスポンスボディ
ファイルのバイナリデータ

注釈

エラーが発生した場合は、Atom 形式のレスポンスとなります。

URL 形式で取得する

出力形式に URL を指定して取得します。

Examples

リクエストの例:

GET /api/fileDownload/V2?id=GROUP,1:2,CABINET,1:3&response-type=url

レスポンスの例:

<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/" />
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:1</uri>
  </author>
  <entry>
    <link rel="download" href="https://cybozulive.com/1_2/gwCabinet/downloadFileDirect?cid=1%3A3" />
    <link rel="mobile-download" href="https://m.cybozulive.com/m/1_2/gwCabinet/downloadFileDirect?cid=1%3A3" />
    <cblCbnt:contentType>image/jpeg</cblCbnt:contentType>
  </entry>
</feed> 

エラーコード

パラメータが不正な場合などにはエラーの XML が返ります。 <error> 要素の中身を確認してください。

  • 対象ファイルが存在しない場合