文档Dynamic Media Image Production System API

renameAsset renameasset

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined

重命名资源。

NOTE
renameFiles参数在以前的版本中已弃用，已从renameAsset中删除。 虚拟文件路径将更改以匹配新的资源名称（保留文件扩展名），而物理文件路径不受影响。 在更新到新的API版本时，API客户端需要移除对此参数的引用。

授权用户类型 section-cc27ad713c6d498b8f056850b20976f4

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
NOTE
用户必须具有资产的读写访问权限。

参数 section-ef95a994106841e0ab346dd4cf672258

输入(renameAssetParam)

名称
类型
必需
说明
companyHandle
xsd:string
是
资产所属公司的句柄。
assetHandle
xsd:string
是
要重命名的资源的句柄。
newName
xsd:string
是
资产的新名称。
validateName
xsd:boolean
是
如果validateName为true，并且资产类型需要唯一的IPS ID，则会检查新名称是否具有全局唯一性，如果renameAsset不是唯一名称，则会引发错误。

输出(renameAssetReturn)

IPS API不返回此操作的响应。 有关此元素的注意事项，请参阅<ns1:validateName>元素的描述。

示例 section-a0ddffd62bec42e09069f22ceb486f8a

此代码示例用于重命名资源

请求

<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>

响应

无。

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681