DokumentationDynamic Media Image Production System API

createAssetSet createassetset

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Skapar en generisk resursuppsättning med en råuppsättningsdefinitionssträng som ska publiceras på en Image Server.

Syntax

Auktoriserade användartyper section-d670d3af552147199b65c7eb847544a3

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parametrar section-3580b586296e42a5b21426085b1bb72d

Indata (createAssetSet)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:string
Ja
Referensen till företaget som innehåller resursuppsättningen.
folderHandle
xsd:string
Ja
Referensen till mappen där den nya resursuppsättningen skapas.
name
xsd:string
Ja
Resursnamn.
subType
xsd:string
Ja
En unik identifierare som skapats av klienten för resursuppsättningstypen.
setDefinition
xsd:string
Nej

Parametrarna i uppsättningsdefinitionssträngen.

Dessa parametrar måste matcha det format som anges av målvisningsprogrammet.

thumbAssetHandle
xsd:string
Nej
Hantera den resurs som fungerar som miniatyrbild för den nya bilduppsättningen. Om inget anges försöker IPS att använda den första bildresursen som uppsättningen refererar till.

Ersättningsfunktioner för setDefinition

Du kan ange infogade ersättningsfunktioner som löses vid katalogsökning eller publicering. Ersättningssträngar har formatet ${<substitution_func>}. Tillgängliga funktioner beskrivs nedan.

NOTE
Handtagslitteralerna i parameterlistor måste omges av hakparenteser ([]). All text som ligger utanför en ersättningssträng kopieras ordagrant till utdatasträngen under upplösningen.
Ersättningsfunktion
Returnerar
getFilePath([asset_handle>])
Resursens primära källfilssökväg.
getCatalogId([<asset_handle>])
Resursens katalog-ID.
getMetaData([<asset_handle>], [<metadata_field_handle>])
Metadatavärden för resursen.
getThumbCatalogId([<asset_handle>])
Resursens katalog-ID (endast för bildbaserade resurser). Den associerade tumresursens katalog-ID (för andra resurser). Om en associerad tumresurs inte är tillgänglig returnerar funktionen en tom sträng.

Exempel på Media setDefinition-sträng

${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])}

Vid katalogsökning, eller publiceringstid, tolkas den här processen som en sträng som liknar följande:

jcompany/myRenderSet;jcompany/myRenderSet;1,jcompany/Videos/Somebodys_N08275_flv.flv;jcomp any/myimg-1;2;20090703 10:05:53

Utdata (createAssetSet)

Namn
Typ
Obligatoriskt
Beskrivning
assetHandle
xsd:string
Ja
Referensen till resursuppsättningen.

Exempel section-fed53089de824d67ab96cd9103d384b4

Begäran

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

Svar

<createAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <assetHandle>a|1801|44|1801</assetHandle>
</createAssetSetReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681