楽天API：R-Cabinet削除フォルダ内の画像一覧取得
R-Cabinet削除フォルダ内の画像一覧を取得するAPI
誤って削除フォルダに移動した画像の有無を確認する用途で使えるAPI。
間違い削除の画像を元に戻す等の利用が出来るが、それ以外あまり用途はないと思われる。
APIメソッド：cabinet.trashbox.files.get
この機能を利用すると、削除フォルダ内にある削除した画像の一覧を取得することができます。
画像の登録、更新、削除後の情報が本機能の取得情報に反映されるまでの時間は最短10秒です。
ページング機能(offset, limit)を用いて情報取得をしている時には画像の登録、更新、削除はお控えください。情報が正しく取得できない場合があります。
Endpoint / HTTP Method
| Endpoint | HTTP Method |
|---|---|
| https://api.rms.rakuten.co.jp/es/1.0/cabinet/trashbox/files/get | GET |
Request
HTTP Header
| No | Key | Value | Note |
|---|---|---|---|
| 1 | Authorization | ESA Base64(serviceSecret:licenseKey) |
Query parameters
| No | Parameter | Description | Type | Mandatory | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | offset | 検索結果取得ページ数 | Integer | 0,1 | 1を基準値とした検索結果取得ページ数 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を10に設定した場合 offset=1、limit=10 → 1件目～10件目のデータを取得する offset=2、limit=10 → 11件目～20件目のデータを取得する offset=3、limit=10 → 21件目～30件目のデータを取得する 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を20に設定した場合 offset=1、limit=20 → 1件目～20件目のデータを取得する offset=2、limit=20 → 21件目～40件目のデータを取得する offset=3、limit=20 → 41件目～60件目のデータを取得する |
|
| 2 | limit | 検索結果取得上限数 | Integer | 0,1 | 検索結果の1ページあたりの取得上限数 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を10に設定した場合 offset=1、limit=10 → 1件目～10件目のデータを取得する offset=2、limit=10 → 11件目～20件目のデータを取得する offset=3、limit=10 → 21件目～30件目のデータを取得する 例）100件データが存在する場合を仮定し、検索結果の1ページあたりの取得上限数を20に設定した場合 offset=1、limit=20 → 1件目～20件目のデータを取得する offset=2、limit=20 → 21件目～40件目のデータを取得する offset=3、limit=20 → 41件目～60件目のデータを取得する ※値は100まで指定可能です。 |
Response
HTTP Header
| No | Key | Value |
|---|---|---|
| 1 | Content-Type | text/xml |
HTTP Body
XML:result
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | result.status | ステータス | XML : status | – | 1 | interfaceId=cabinet.trashbox.files.get |
| 2 | result.cabinetTrashboxFilesGetResult | 削除フォルダ内画像情報取得結果 | XML: cabinetTrashboxFilesGetResult | – | 1 |
XML:cabinetTrashboxFilesGetResult
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | cabinetTrashboxFilesGetResult.resultCode | 結果コード | Integer | 4 | 1 | |
| 2 | cabinetTrashboxFilesGetResult.fileAllCount | 全画像数 | Integer | 5 | 1 | |
| 3 | cabinetTrashboxFilesGetResult.fileCount | 返却画像数 | Integer | 5 | 1 | |
| 4 | cabinetTrashboxFilesGetResult.files | 画像情報リスト | XML:files | – | 1 |
XML:cabinetTrashboxFilesGetResult
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | files.file | 画像情報 | XML : file | – | 1…n |
XML:cabinetTrashboxFilesGetResult
| No | Element | Description | Type | Size(byte) | Multiplicity | Note | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | file.FolderNode | フォルダノード | Integer | 1 | 1 | 0 or 1 or 2 or 3 基本フォルダの場合： 0 |
|||||
| 2 | file.FolderPath | フォルダパス | String | 153 | 1 | path1/path2/path3 区切り文字は”/”です。 基本フォルダの場合： / |
|||||
| 3 | file.FileId | 画像ID | Integer | 10 | 1 | ||||||
| 4 | file.FileName | 画像名 | String | 50 | 1 | ||||||
| 5 | file.FileUrl | 画像保存先 | String | 265 | 1 | ||||||
| 6 | file.FilePath | file名 | String | 50 | 1 | ||||||
| 7 | file.FileType | 画像タイプ | Integer | 1 | 1 | 1: jpg 2: gif (画像) 3: gif (動画) |
|||||
| 8 | file.FileSize | 画像サイズ (KB) | Decimal | 7 | 1 | 小数点第3位まで 0.000の場合： 0 |
|||||
| 9 | file.FileWidth | 画像の横幅 | Integer | 4 | 1 | ||||||
| 10 | file.FileHeight | 画像の縦幅 | Integer | 4 | 1 | ||||||
| 11 | file.FileAccessDate | 画像アクセス日 | Date | 10 | 1 | ||||||
| 12 | file.TimeStamp | 画像情報更新日時 | DateTime | 19 | 1 | ||||||
-
前の記事
楽天API：商品画像を削除フォルダに移動 2018.09.14
-
次の記事
楽天API：削除フォルダの画像を指定して移動 2018.09.14