ファイルを取得する

フォローする

ファイル情報を取得する

フォルダIDをリクエストのパラメーターとして受け取り、ファイル一覧の情報をレスポンスとして返す API です。

API名

CabinetGetFileInfo

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名 パラメーター数 説明
@hid base:IDType 1 フォルダID

<parameters hid="2"> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
file_information cabinet:FileInformationType 1 ファイル一覧の情報

<returns xmlns=""> 
  <file_information> 
    <files parent_id="4" parent_code="foldercode1-1"> 
      <file id="2" folder_id="4"> 
        <title>picture</title> 
        <description> 
          <![CDATA[test]]> 
        </description> 
        <max_version>3</max_version> 
        <name>IMG_0217.JPG</name> 
        <size>792581</size> 
        <mime_type>image/jpeg</mime_type> 
        <creator_id>1</creator_id> 
        <creator_login_name>Administrator</creator_login_name> 
        <creator_display_name>Administrator</creator_display_name> 
        <create_time>2010-08-31T10:57:10+0900</create_time> 
        <modifier_id>1</modifier_id> 
        <modifier_login_name>Administrator</modifier_login_name> 
        <modifier_display_name>Administrator</modifier_display_name> 
        <modify_time>2010-08-31T10:57:10+0900</modify_time> 
        <histories> 
          <history> 
            <version>1</version> 
            <active>1</active> 
            <name>IMG_0217.JPG</name> 
            <action>1</action> 
            <comment/> 
            <modifier_id>1</modifier_id> 
            <modifier_login_name>Administrator</modifier_login_name> 
            <modifier_display_name>Administrator</modifier_display_name> 
            <modify_time>2010-08-31T10:57:10+0900</modify_time> 
          </history> 
        </histories> 
      </file> 
    </files> 
  </file_information> 
</returns>

エラー

エラー番号 説明
GRN_CBNT_17002 指定したフォルダが存在しない場合

ファイルをダウンロードする

ファイル ID をリクエストのパラメーターとして受け取り、ファイルをダウンロードする API です。ファイルはBase64でエンコードして返されます。

API名

CabinetFileDownload

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名 パラメーター数 説明
@file_id base:IDType 1 ファイルID

<parameters file_id="2"> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
file base:FileBodyType 0 ~ 1 ファイルの内容

<returns xmlns=""> 
  <file> 
    <content> 
      /9j/4QBYRXhpZgAATU0AKgAAAAgAAgESAA 
    </content> 
  </file> 
</returns>

エラー

エラー番号 説明
GRN_CBNT_17004 指定したファイルが存在しない場合

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk