ファイルを取得する
ファイル情報を取得する
フォルダーIDをリクエストのパラメーターとして受け取り、ファイル一覧の情報をレスポンスとして返すAPIです。
API名
CabinetGetFileInfo
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @hid | base:IDType | 1 | フォルダーID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| file_information | cabinet:FileInformationType | 1 | ファイル一覧の情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_CBNT_17002 | 指定したフォルダーが存在しない場合 |
ファイルをダウンロードする
ファイルIDをリクエストのパラメーターとして受け取り、ファイルをダウンロードするAPIです。ファイルはBase64でエンコードして返されます。
API名
CabinetFileDownload
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @file_id | base:IDType | 1 | ファイルID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| file | base:FileBodyType | 0~1 | ファイルの内容 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_CBNT_17004 | 指定したフォルダーが存在しない場合 |
