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

renameAsset renameasset

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者
  • 管理者

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

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