renameAsset

Dernière mise à jour : 2022-03-09
  • Créé pour :
  • Developer
    Admin

Renomme une ressource.

REMARQUE

Le renameFiles a été abandonné pour les versions antérieures et supprimé de renameAsset. Le chemin d’accès au fichier virtuel est modifié pour correspondre au nouveau nom de la ressource (en conservant l’extension du fichier), tandis que les chemins d’accès aux fichiers physiques ne sont pas affectés. Les clients API doivent supprimer les références à ce paramètre lors de la mise à jour vers la nouvelle version de l’API.

Types d’utilisateurs autorisés

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
REMARQUE

L’utilisateur doit disposer d’un accès en lecture et en écriture à la ressource.

Paramètres

Entrée (renameAssetParam)

Nom Type Obligatoire Description
companyHandle xsd:string Oui Gestionnaire de la société à laquelle appartient la ressource.
assetHandle xsd:string Oui Gestionnaire de la ressource que vous souhaitez renommer.
newName xsd:string Oui Nouveau nom de la ressource.
validateName xsd:boolean Oui Si la variable validateName is true et que le type de ressource nécessite un identifiant IPS unique, le nouveau nom est analysé pour l’unicité globale et renameAsset renvoie une erreur si elle n’est pas unique.

Sortie (renameAssetReturn)

L’API IPS ne renvoie pas de réponse pour cette opération. Voir la description de la variable <ns1:validateName> pour les avertissements relatifs à cet élément.

Exemples

Cet exemple de code renomme une ressource

Request

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

Réponse

Aucune

Sur cette page