檔案與目錄之基本操作

建立目錄(/folder/create/)

伺服器：InfoRelay

目的：此 API 可供客戶端建立目錄。客戶端建立目錄時，須先指定父目錄(Parent Folder) 為何。被建立的目錄名稱是經 Base64(UTF-8) 編碼後的結果。

※ 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application) 必須在 HTTP Header 中提供 SID及ProgKey(必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStore Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前 OmniStor 系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/folder/create/

Input

<!--?xml version="1.0" encoding="utf-8" ?-->
<create>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <parent>{ Parent Folder ID }</parent>    <!-- 系統資料夾(請參閱註解)本身不能成為 /folder/create/ 群組編輯功能指定的目錄 -->
    <isencrypted>[ 0 | 1 ]</isencrypted>
    <display>{ 以Base64(UTF-8)編碼的目錄名稱 }</display>    <!-- 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。-->
    <attribute>{ Data(請參閱註解) }</attribute>
    <isgroupaware>[ 0 | 1 ]</isgroupaware>    <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 -->
</create>

Output

<!--?xml version="1.0" encoding="utf-8" ?-->
<create>
    <status>{ Status Code }</status>
    <id>{ Folder ID }</id>
</create>

回傳的狀態碼(Status Code)

系統資料夾ID列表

移動目錄(/folder/move/)

伺服器：InfoRelay

目的：此API可供客戶端移動指定目錄至目的地目錄之下。目錄名稱為經 Base64(UTF-8)編碼的結果。

※ 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application)必須在 HTTP Header 中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStor Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前OmniStor系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/folder/move/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <move> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ Folder ID }</id> <display>{ 以 Base64(UTF-8) 編碼的目錄名稱 }</display><!-- 被移動的指定目錄名稱。若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。 --> <parent>{ New Parent Folder ID }</parent> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 --> </move>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾ID列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

移除目錄(/folder/remove/)

伺服器：InfoRelay

目的：此 API 供客戶端刪除指定的目錄，並且可以批次刪除。預設情況下，參數 ischildonly 為 0，系統將刪除掉客戶端指定的目錄及其之下的子目錄和檔案；然而，當參數 ischildonly 設定為 1 時，只刪除指定目錄之下的子目錄及檔案，不刪除指定目錄本身。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application) 必須在 HTTP Header 中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStor Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前 OmniStor 系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/folder/remove/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <remove> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ Folder ID1, Folder ID2, Folder ID3… }</id><!-- 最多500個--> <ischildonly>[ 0 | 1 ]</ischildonly><!-- 0：全刪，包括指定目錄本身以及指定目錄下的子目錄和檔案(預設值) | 1：只刪子目錄不刪本身 --> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 --> </remove>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾ID列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

移動檔案(/file/move/)

伺服器：InfoRelay

目的：此 API 可供客戶端移動指定的檔案至指定的目錄下。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application) 必須在 HTTP Header中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 ASUSCloud Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知OmniStor系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前OmniStor系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/file/move/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <move> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ File ID }</id> <parent>{ New Parent Folder ID }</parent> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 --> </move>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾 ID 列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

移除檔案(/file/remove/)

伺服器：InfoRelay

目的：接受客戶端要求，刪除客戶端指定的檔案。可一次指定多個檔案來刪除，若刪除任何一個檔案失敗，則將恢復異動前的狀態。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application) 必須在 HTTP Header 中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStor Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前 OmniStor 系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/file/remove/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <remove> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ File ID1, File ID2, File ID3…以逗點分隔欲刪除的File ID }</id> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay 分享功能簡介」的說明 --> </remove>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾ID列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

複製檔案(/file/copy/)

伺服器：InfoRelay

目的：此API可供客戶端複製一個或多個檔案至目的地目錄下。

※ 註：指定檔案皆須屬於同一目錄下。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application)必須在 HTTP Header 中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 ASUSCloud Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前OmniStor系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/file/copy/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <copy> <token>{ token }</token> <userid>{ User ID }</userid> <parent>{ New Parent Folder ID }</parent> <!-- fileid element可以重覆多次 --> <fileid>{ File ID#1 }</fileid> <fileid>{ File ID#2 }</fileid> <fileid>{ …… }</fileid> <fileid>{ File ID#N }</fileid> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay 分享功能簡介」的說明 --> </copy>

Output

<!--?xml version="1.0" encoding="utf-8"?--> <copy> <status>{ Status Code }</status> <fileid>{ File ID#1 }</fileid> <!-- fileid：複製成功後新的 File ID --> <fileid>{ File ID#2 }</fileid> <fileid>{ …… }</fileid> <fileid>{ File ID#N }</fileid> <failid>{ File ID#1 }</failid> <!-- failid：複製失敗的 File ID --> <failid>{ File ID#2 }</failid> <failid>{ …… }</failid> <failid>{ File ID#N }</failid> </copy>

回傳的狀態碼(Status Code)

註解

系統資料夾 ID 列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

重新命名目錄(/folder/rename/)

伺服器：InfoRelay

目的：此 API 可供客戶端賦予指定目錄新的名稱。目錄名稱為經 Base64(UTF-8) 編碼的結果。

※ 若您使用的開發語言為R uby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application)必須在 HTTP Header中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStor Server 的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前 OmniStor 系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/folder/rename/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <rename> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ Folder ID }</id> <isencrypted>[ 0 | 1 ]</isencrypted> <display>{ 以Base64(UTF-8) 編碼的目錄名稱 }</display><!-- 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。--> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 --> </rename>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾 ID 列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。

重新命名檔案(/file/rename/)

伺服器：InfoRelay

目的：此 API 可供客戶端賦予指定檔案新的名稱。檔案名稱為經 Base64(UTF-8) 編碼的結果。

※ 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。

協同合作資料夾：

如欲使用協同合作資料夾功能時，其操作之客戶端應用程式(Client Application)必須在 HTTP Header 中提供 SID 及 ProgKey (必須採用 Authorization 的方式，Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)，當 SID 及 ProgKey 通過 OmniStor Server的認證後，方能啟用協同合作資料夾功能(如欲詳知 OmniStor 系統所提供的分享功能，請參照本文件「分享功能簡介」)。

※ 註：目前 OmniStor 系統未提供跨服務區域(請參閱註解)使用群組編輯的功能。

/file/rename/

Input

<!--?xml version="1.0" encoding="utf-8" ?--> <rename> <token>{ token }</token> <userid>{ User ID }</userid> <id>{ File ID }</id> <display>{ 以 Base64(UTF-8) 編碼後的新檔案名稱 }</display><!-- 若您使用的開發語言為 Ruby，請用 Base64.strict_encode64，避免“\n”在編碼之後出現。--> <isencrypted>[ 0 | 1 ]</isencrypted> <isgroupaware>[ 0 | 1 ]</isgroupaware> <!-- 1：啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 --> </rename>

Output

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

回傳的狀態碼(Status Code)

註解

系統資料夾 ID 列表

※ 「我的收藏」資料夾：
{package}是從 AcquireToken API 所回傳的 XML Payload 中取得，為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

1. 表示星號。