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

createImageSet

Última atualização: 20 de julho de 2024

Tópicos:

Criado para:

Desenvolvedor
Administrador

Cria um conjunto de imagens.

Sintaxe

Tipos de usuário autorizados

IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser

OBSERVAÇÃO

O usuário deve ter acesso de leitura/gravação à pasta de destino.

Parâmetros

Entrada (createImageSetParam)

Nome	Tipo	Obrigatório	Descrição
companyHandle	`xsd:string`	Sim	O identificador da empresa à qual o conjunto de imagens pertence.
folderHandle	`xsd:string`	Sim	O identificador da pasta.
name	`xsd:string`	Sim	Nome do conjunto de imagens.
type	`xsd:string`	Sim	Tipo de conjunto de imagens.
thumbAssetHandle	`xsd:string`	Não	Identificador do ativo que atua como a miniatura do novo conjunto de imagens. Se não for especificado, o IPS tentará usar o primeiro ativo de imagem referenciado pelo conjunto.

Saída

Nome	Tipo	Obrigatório	Descrição
assetHandle	`xsd:string`	Sim	O identificador para o novo conjunto de imagens.

Exemplos

Essa amostra de código cria um conjunto de imagens especificado por empresa, pasta, nome e tipo. A resposta é um identificador de ativo do conjunto de imagens recém-criado.

Solicitação

<ns1:createImageSetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:folderHandle>MyCompany/eCatalogs/</ns1:folderHandle>
   <ns1:name>My Image Set</ns1:name>
   <ns1:type>ImageSet</ns1:type>
</ns1:createImageSetParam>

Resposta

<createImageSetReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <assetHandle>25741|22|841</assetHandle>
</createImageSetReturn>

recommendation-more-help