DokumentationDynamic Media Image Production System-API

createAssetSet createassetset

Last update: Mon Dec 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Erstellt ein generisches Asset mit einer Zeichenfolge für die Definition des Rohsatzes, das auf einem Bild-Server veröffentlicht werden soll.

Syntax

Autorisierte Benutzertypen section-d670d3af552147199b65c7eb847544a3

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

Parameter section-3580b586296e42a5b21426085b1bb72d

Eingabe (createAssetSet)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Das -Handle an die Firma, die den Asset-Satz enthält.
folderHandle
xsd:string
Ja
Das Handle für den Ordner, in dem der neue Asset-Satz erstellt wird.
Name
xsd:string
Ja
Asset-Name.
Untertyp
xsd:string
Ja
Eine eindeutige Kennung, die vom Client für den Asset-Typ erstellt wurde.
setDefinition
xsd:string
Nein

Die Parameter in der festgelegten Definitionszeichenfolge.

Diese Parameter müssen in das vom Ziel-Viewer angegebene Format aufgelöst werden.

ThumbAssetHandle
xsd:string
Nein
Handle des Assets, das als Miniatur für das neue Bildset fungiert. Wenn kein Wert angegeben ist, versucht IPS, das erste Bild-Asset zu verwenden, auf das vom Set verwiesen wird.

Substitutionsfunktionen für setDefinition

Sie können Inline-Substitutionsfunktionen angeben, die während der Katalogsuche oder -veröffentlichung aufgelöst werden. Ersatzzeichenfolgen haben das Format ${<substitution_func>}. Die verfügbaren Funktionen sind unten beschrieben.

NOTE
Die Handler-Literale in Parameterlisten müssen von ([]) Klammern umgeben sein. Sämtlicher Text außerhalb einer Ersatzzeichenfolge wird bei der Auflösung wortgetreu in die Ausgabezeichenfolge kopiert.
Substitutionsfunktion
Rückgabe
getFilePath([asset_handle>])
Pfad der Primärdatei des Assets.
getCatalogId([<asset_handle>])
Die Katalog-ID des Assets.
getMetaData([<asset_handle>], [<metadata_field_handle>])
Metadatenwerte für das Asset.
getThumbCatalogId([<asset_handle>])
Die Katalog-ID des Assets (nur für bildbasierte Assets). Die Katalog-ID des zugehörigen Miniatur-Assets (für andere Assets). Wenn kein verknüpftes Thumb-Asset verfügbar ist, gibt die Funktion eine leere Zeichenfolge zurück.

Beispiel für eine Media SetDefinition-Zeichenfolge

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

Bei der Katalogsuche oder Veröffentlichungszeit wird dieser Prozess in eine Zeichenfolge ähnlich der folgenden aufgelöst:

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

Ausgabe (createAssetSet)

Name
Typ
Erforderlich
Beschreibung
assetHandle
xsd:string
Ja
Das Handle zum Asset-Set.

Beispiele section-fed53089de824d67ab96cd9103d384b4

Anfrage

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

Antwort

<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