DocumentaçãoAPI do sistema de produção de imagens Dynamic Media

renameAsset renameasset

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
  • Administrador

Renomeia um ativo.

NOTE
O parâmetro renameFiles foi substituído em 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 section-cc27ad713c6d498b8f056850b20976f4

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImpagePortalContribUser
NOTE
O usuário deve ter acesso de leitura e gravação ao ativo.

Parâmetros section-ef95a994106841e0ab346dd4cf672258

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 o validateName for true e o tipo de ativo exigir uma ID de IPS exclusiva, o novo nome será verificado para exclusividade global e renameAsset acionará uma falha se 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 elemento <ns1:validateName> para avisos sobre esse elemento.

Exemplos section-a0ddffd62bec42e09069f22ceb486f8a

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.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681