renameAsset

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

メモ

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>

応答

なし

このページ