ドキュメントAEMDynamic Media Image Production System API

renameAsset renameasset

最終更新日： 2024年7月22日

作成対象：

  • Developer
  • Admin

アセットの名前を変更します。

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
dynamic-media-developer-resources-help-aem-ips-api