renameAsset

Benennt ein Asset um.

HINWEIS

Der Parameter renameFiles wurde für frühere Versionen nicht mehr unterstützt und aus renameAsset entfernt. Der virtuelle Dateipfad wird so geändert, dass er mit dem neuen Asset-Namen übereinstimmt (wobei die Dateierweiterung beibehalten wird), während die physischen Dateipfade nicht betroffen sind. API-Clients müssen beim Aktualisieren auf die neue API-Version Verweise auf diesen Parameter entfernen.

Autorisierte Benutzertypen

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
HINWEIS

Der Benutzer muss Lese- und Schreibzugriff auf das Asset haben.

Parameter

Eingabe (renameAssetParam)

Name Typ Erforderlich Beschreibung
*companyHandle* xsd:string Ja Das Handle des Unternehmens, zu dem das Asset gehört.
*assetHandle* xsd:string Ja Das Handle für das Asset, das Sie umbenennen möchten.
*newName* xsd:string Ja Der neue Name des Assets.
*validateName* xsd:boolean Ja Wenn validateName true ist und der Asset-Typ eine eindeutige IPS-ID erfordert, wird der neue Name auf globale Eindeutigkeit überprüft und renameAsset gibt einen Fehler aus, wenn er nicht eindeutig ist.

Ausgabe (renameAssetReturn)

Die IPS-API gibt keine Antwort für diesen Vorgang zurück. Einschränkungen zu diesem Element finden Sie in der Beschreibung des Elements <ns1:validateName> .

Beispiele

Mit diesem Codebeispiel wird ein Asset umbenannt.

Anforderung

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

Antwort

Keine.

Auf dieser Seite