更名資產

更名資產。

注意

renameFiles 參數已棄用於以前的版本,並已從中刪除 renameAsset。 虛擬檔案路徑被更改以與新資產名稱匹配(保留檔案副檔名),而物理檔案路徑不受影響。 API客戶端在更新到新API版本時需要刪除對此參數的引用。

授權用戶類型

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
注意

用戶必須具有對資產的讀寫權限。

參數

輸入(renameAssetParam)

名稱 類型 必要 說明
公司句柄 xsd:string 資產所屬公司的句柄。
資產句柄 xsd:string 要更名的資產的句柄。
新名稱 xsd:string 資產的新名稱。
validateName xsd:boolean 如果 validateNametrue 並且資產類型需要唯一的IPS ID,然後檢查新名稱是否具有全局唯一性, renameAsset 如果它不是唯一的,則拋出錯誤。

輸出(renameAssetReturn)

IPS API不會為此操作返迴響應。 請參閱 <ns1:validateName> 元素。

範例

此代碼示例更名資產

請求

<ns1:renameAssetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:assetHandle>24265|1|17061</ns1:assetHandle>
   <ns1:newName>My Newly Renamed Image</ns1:newName>
   <ns1:validateName>true</ns1:validateName>
   <ns1:renameFiles>true</ns1:renameFiles>
</ns1:renameAssetParam>

回答

無。

本頁內容