renameAsset

最終更新日: 2022-03-08
  • 作成対象:
  • Developer
    Admin

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

メモ

この renameFiles パラメーターは以前のリリースで非推奨となり、から削除されました renameAsset. 仮想ファイルのパスは、新しいアセット名(ファイル拡張子を維持)に一致するように変更されますが、物理ファイルのパスは影響を受けません。 API クライアントは、新しい API バージョンに更新する際に、このパラメーターへの参照を削除する必要があります。

認証済みユーザータイプ

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
メモ

ユーザーは、アセットに対する読み取りおよび書き込みアクセス権を持っている必要があります。

パラメータ

入力 (renameAssetParam)

名前 種類 必須 説明
companyHandle xsd:string はい アセットが属する会社のハンドル。
assetHandle xsd:string はい 名前を変更するアセットのハンドル。
newName 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>

応答

なし

このページ