Page Comparison

資源回收筒簡介

OmniStor 系統提供「資源回收筒(MyRecycleBin)」的優化機制，加強用戶刪除檔案／目錄操作的彈性。
用戶於一般資料夾中刪除的檔案／目錄可於資源回收筒中找到，用戶可操作是否還原指定檔案／目錄至目的地目錄之下或者永久清除該檔案／目錄。
附註：一般資料夾(例如：同步資料夾)。

一、資源回收筒還原功能：

資源回收筒還原功能

呼叫 /folder/getpersonalsystemfolder/，取得資源回收筒 ID。
呼叫 /folder/browse/，瀏覽資源回收筒之下的目錄及檔案資訊(例如：File ID／Folder ID)。
指定欲還原的File ID／Folder ID，呼叫 /folder/restore/ 或是 /file/restore/ 進行還原。

二、資源回收筒永久清除功能：

資源回收筒永久清除功能

呼叫 /folder/getpersonalsystemfolder/，取得資源回收筒ID。
呼叫 /folder/browse/，瀏覽資源回收筒之下的目錄及檔案資訊(例如：File ID／Folder ID)。
指定欲永久清除的File ID／Folder ID，呼叫 /folder/clearrecyclebin/ 或是 /file/clearrecyclebin/ 進行永久清除。

還原資源回收筒中的指定目錄

伺服器：InfoRelay
目的：此 API 可供客戶端在資源回收筒中指定目錄還原至目的地目錄之下。

POST /folder/restore/

Input

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8"?-->
<restore>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <parent>{ Parent Folder ID }</parent>    <!-- folderid element 可以重覆多次，指定多筆目錄 -->
    <folderid>{ 欲還原的 Folder ID#1 }</folderid>
    <folderid>{ 欲還原的 Folder ID#2 }</folderid>
    <folderid>{ …… }</folderid>
    <folderid>{ 欲還原的 Folder ID#N }</folderid>
</restore>

Output

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8"?-->
<restore>
    <status>{ Status Code }</status>
    <parent>{ 還原後的 Parent Folder ID }</parent>
</restore>

回傳的狀態碼(Status Code)

狀態碼	狀態描述
0	Success。
2	Authentication Fail。
215	移動的目的地與來源目錄的上一層為同一目錄。
216	目的地目錄不存在。
218	被移動的指定目錄不存在。
225	上傳參數錯誤。
233	指定被移動的目錄與目的地目錄不在同一目錄樹下。
235	上傳參數的操作要求錯誤。
236	Target parent for restoring not assigned。
242	Insufficient capacity。
999	General Error。

還原資源回收筒中的指定檔案

伺服器：InfoRelay
目的：此API可供客戶端在資源回收筒中指定檔案還原至目的地目錄之下。

POST /file/restore/

Input

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8"?-->
<restore>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <parent>{ Parent Folder ID }</parent>    <!-- fileid element 可以重覆多次，指定多筆檔案 -->
    <fileid>{ 欲還原的 File ID#1 }</fileid>
    <fileid>{ 欲還原的 File ID#2 }</fileid>
    <fileid>{ …… }</fileid>
    <fileid>{ 欲還原的 File ID#N }</fileid>
</restore>

Output

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8"?-->
<restore>
    <status>{ Status Code }</status>
    <parent>{ 還原後的 Parent Folder ID }</parent>
</restore>

回傳的狀態碼(Status Code)

狀態碼	狀態描述
0	Success。
2	Authentication Fail。
215	移動的目的地與來源目錄之上一層為同一個目錄。
216	移動的目的地目錄不存在。
218	目錄不存在或已刪除。
219	檔案不存在或已刪除。
225	上傳參數錯誤。
233	指定被移動的目錄與目的地目錄不在同一目錄樹下。
235	上傳參數的操作要求錯誤。
236	Target parent for restoring not assigned。
242	Insufficient capacity。
999	General Error。

永久清除資源回收筒中的指定目錄

伺服器：InfoRelay
目的：此 API 可供客戶端在資源回收筒中永久清除指定的目錄。若欲清除的目錄下有檔案／目錄，也將一併清除。若指定的目錄為資源回收筒本身，那麼將一次清空資源回收桶中所有的檔案／目錄。

POST /folder/clearrecyclebin/

Input

Code Block

<clearrecyclebin>
    <token>{ token }</token>
    <userid>{ User ID }</userid>    <!-- folderid element 可以重覆多次，指定多筆目錄 -->
    <folderid>{ 欲刪除的 Folder ID#1 }</folderid>
    <folderid>{ 欲刪除的 Folder ID#2 }</folderid>
    <folderid>{ …… }</folderid>
    <folderid>{ 欲刪除的 Folder ID#N }</folderid>
</clearrecyclebin>

Output

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8"?-->
<clearrecyclebin>
    <status>{ Status Code }</status>
    <scrip>{ scrip }</scrip>
</clearrecyclebin>

回傳的狀態碼(Status Code)

狀態碼	狀態描述
0	Success。
2	Authentication Fail。
3	Payload is not validate。
225	參數值不在容許的定義域內(例如：不屬於資源回收筒的目錄)。
999	General Error。

永久清除資源回收筒中的指定檔案

伺服器：InfoRelay
目的：此 API 可供客戶端在資源回收筒中永久清除指定的檔案。

POST /file/clearrecyclebin/

Input

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8" ?-->
<clearrecyclebin>
    <token>{ token }</token>
    <userid>{ User ID }</userid>    <!-- fileid element 可以重覆多次，指定多筆檔案 -->
    <fileid>{ 欲刪除的 File ID#1 }</fileid>
    <fileid>{ 欲刪除的 File ID#2 }</fileid>
    <fileid>{ …… }</fileid>
    <fileid>{ 欲刪除的 File ID#N }</fileid>
</clearrecyclebin>

Output

Code Block

language	xml

<!--?xml version="1.0" encoding="utf-8" ?-->
<clearrecyclebin>
    <status>{ Status Code }</status>
    <scrip>{ scrip }</scrip>
</clearrecyclebin>

回傳的狀態碼(Status Code)

狀態碼	狀態描述
0	Success。
2	Authentication Fail。
3	Payload is not validate。
225	參數值不在容許的定義域內(例如：不屬於資源回收筒的檔案)。
999	General Error。

Table of Contents

indent	20px
absoluteUrl	true
style	circle

Versions Compared

Old Version 2

New Version Current

Key

資源回收筒簡介

資源回收筒還原功能

資源回收筒永久清除功能

還原資源回收筒中的指定目錄

POST /folder/restore/

Input

Output

回傳的狀態碼(Status Code)

還原資源回收筒中的指定檔案

POST /file/restore/

Input

Output

回傳的狀態碼(Status Code)

永久清除資源回收筒中的指定目錄

POST /folder/clearrecyclebin/

Input

Output

回傳的狀態碼(Status Code)

永久清除資源回收筒中的指定檔案

POST /file/clearrecyclebin/

Input

Output

回傳的狀態碼(Status Code)