createAssetSet
Criado para:
- Desenvolvedor
- Administrador
Cria um conjunto de ativos genérico com uma cadeia de caracteres de definição de conjunto bruto a ser publicada em um Servidor de imagens.
Sintaxe
Tipos de usuário autorizados
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Parâmetros
Entrada (createAssetSet)
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
companyHandle | xsd:string | Sim | O identificador da empresa que contém o conjunto de ativos. |
folderHandle | xsd:string | Sim | O identificador da pasta na qual o novo conjunto de ativos é criado. |
nome | xsd:string | Sim | Nome do ativo. |
subtipo | xsd:string | Sim | Um identificador exclusivo criado pelo cliente para o tipo de conjunto de ativos. |
setDefinition | xsd:string | Não |
Os parâmetros na cadeia de caracteres de definição do conjunto. Esses parâmetros devem ser resolvidos para o formato especificado pelo visualizador de destino. |
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. |
Funções de Substituição para setDefinition
Você pode especificar funções de substituição em linha que são resolvidas durante a pesquisa de catálogo ou publicação. Cadeias de substituição têm o formato ${<substitution_func>}
. As funções disponíveis são descritas abaixo.
([])
. Todo o texto que está fora de uma cadeia de caracteres de substituição é copiado textualmente para a cadeia de caracteres de saída durante a resolução.Função de Substituição | Devoluções |
---|---|
getFilePath([asset_handle>]) | O caminho do arquivo de origem principal do ativo. |
getCatalogId([<asset_handle>]) | A ID do catálogo do ativo. |
getMetaData([<asset_handle>], [<metadata_field_handle>]) | Valores de metadados para o ativo. |
getThumbCatalogId([<asset_handle>]) | A ID do catálogo do ativo (somente para ativos baseados em imagem). A ID de catálogo do ativo de miniatura associado (para outros ativos). Se um ativo de miniatura associado não estiver disponível, a função retornará uma cadeia de caracteres vazia. |
Exemplo de cadeia de caracteres de definição de conjunto de mídia
${getCatalogId([a|1664|22|1664])};${getCatalogId([a|1664|22|1664])};1,${getFilePath([a|103
6|19|144])};${getCatalogId([a|452|1|433])};2;${getMetadata([a|1036|19|144], [m|1|ASSET|SharedDateField])}
Na pesquisa de catálogo ou no momento da publicação, esse processo é resolvido como uma cadeia de caracteres semelhante à seguinte:
jcompany/myRenderSet;jcompany/myRenderSet;1,jcompany/Videos/Somebodys_N08275_flv.flv;jcomp any/myimg-1;2;20090703 10:05:53
Saída (createAssetSet)
xsd:string
Exemplos
Solicitação
<createAssetSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<folderHandle>f|jcompany/AssetSets/</folderHandle>
<name>testAssetSet</name>
<subType>MediaSet</subType>
</createAssetSetParam>
Resposta
<createAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<assetHandle>a|1801|44|1801</assetHandle>
</createAssetSetReturn>