DocumentatieDynamic Media Image Production System API

createAssetSet createassetset

Last update: Fri Sep 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
  • Beheerder

Creeert een generisch element dat met een ruwe reeks definitiekoord wordt geplaatst dat aan een Server van het Beeld moet worden gepubliceerd.

Syntaxis

Geautoriseerde gebruikerstypen section-d670d3af552147199b65c7eb847544a3

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

Parameters section-3580b586296e42a5b21426085b1bb72d

Input (createAssetSet)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:tekenreeks
Ja
De handgreep naar het bedrijf dat de set elementen bevat.
folderHandle
xsd:tekenreeks
Ja
De handgreep naar de map waarin de nieuwe elementenset wordt gemaakt.
name
xsd:tekenreeks
Ja
Elementnaam.
subType
xsd:tekenreeks
Ja
Een unieke id die door de client is gemaakt voor het type elementenset.
setDefinition
xsd:tekenreeks
Nee

De parameters in de reeks definitiereeks.

Deze parameters moeten worden omgezet in de indeling die is opgegeven door de doelviewer.

thumbAssetHandle
xsd:tekenreeks
Nee
Handgreep van het element dat fungeert als miniatuur voor de nieuwe afbeeldingsset. Als gespecificeerd niet, probeert IPS om het eerste beeldmiddel te gebruiken dat door de reeks van verwijzingen wordt voorzien.

Vervangende functies voor setDefinition

U kunt vervangende functies inline opgeven die worden opgelost tijdens het opzoeken of publiceren van een catalogus. Vervangende tekenreeksen hebben de indeling ${<substitution_func>}. Beschikbare functies worden hieronder beschreven.

NOTE
De handgreepliterals in parameterlijsten moeten tussen haakjes staan ([]). Alle tekst die zich buiten een vervangende tekenreeks bevindt, wordt tijdens de resolutie letterlijk naar de uitvoertekenreeks gekopieerd.
Vervangende functie
Retourneert
getFilePath([asset_handle>])
Het primaire bronbestandspad van het element.
getCatalogId([<asset_handle>])
De catalogus-id van het element.
getMetaData([<asset_handle>], [<metadata_field_handle>])
Metagegevenswaarden voor het element.
getThumbCatalogId([<asset_handle>])
De catalogus-id van het element (alleen voor op afbeeldingen gebaseerde elementen). De catalogus-id van het bijbehorende blokelement (voor andere elementen). Als een gekoppeld blokelement niet beschikbaar is, retourneert de functie een lege tekenreeks.

Sample Media setDefinition String

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

Tijdens het opzoeken of publiceren van een catalogus wordt dit proces omgezet in een tekenreeks die lijkt op het volgende:

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

Uitvoer (createAssetSet)

Naam
Type
Vereist
Beschrijving
assetHandle
xsd:string
Ja
De greep naar de set elementen.

Voorbeelden section-fed53089de824d67ab96cd9103d384b4

Verzoek

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

Antwoord

<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