renameAsset

Última atualização em 2023-05-20
  • Criado para:
  • Developer
    Admin

Renomeia um ativo.

OBSERVAÇÃO

A variável renameFiles foi descontinuado para versões anteriores e removido de renameAsset. O caminho do arquivo virtual é alterado para corresponder ao novo nome do ativo (preservando a extensão do arquivo), enquanto os caminhos do arquivo físico não são afetados. Os clientes da API precisam remover as referências a esse parâmetro ao atualizar para a nova versão da API.

Tipos de usuário autorizados

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
OBSERVAÇÃO

O usuário deve ter acesso de leitura e gravação ao ativo.

Parâmetros

Entrada (renameAssetParam)

Nome Tipo Obrigatório Descrição
companyHandle xsd:string Sim O identificador da empresa à qual o ativo pertence.
assetHandle xsd:string Sim O identificador do ativo que você deseja renomear.
newName xsd:string Sim Novo nome do ativo.
validateName xsd:boolean Sim Se a variável validateName é true e o tipo de ativo exigir uma ID de IPS exclusiva, então o novo nome será verificado em busca de exclusividade global e renameAsset aciona uma falha se ela não for exclusiva.

Saída (renameAssetReturn)

A API do IPS não retorna uma resposta para esta operação. Consulte a descrição do <ns1:validateName> elemento para avisos sobre esse elemento.

Exemplos

Esta amostra de código renomeia um ativo

Solicitação

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

Resposta

Nenhum.

Página anterior
Next page

Nesta página