Dokumentation Dynamic Media Image Production System-API

createImageSet

30. Dezember 2024

Themen:

Erstellt für:

Entwickler
Admin

Erstellt ein Bildset.

Syntax

Autorisierte Benutzertypen

IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser

NOTE

Die Benutzerin bzw. der Benutzer muss Lese-/Schreibzugriff auf den Zielordner haben.

Parameter

Input (createImageSetParam)

Name	Typ	Erforderlich	Beschreibung
companyHandle	`xsd:string`	Ja	Das Handle für das Unternehmen, zu dem das Bildset gehört.
folderHandle	`xsd:string`	Ja	Der Handle zum Ordner.
name	`xsd:string`	Ja	Name des Bildsets.
Typ	`xsd:string`	Ja	Typ des Bildsets.
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.

Ausgabe

Name	Typ	Erforderlich	Beschreibung
assetHandle	`xsd:string`	Ja	Der Ziehpunkt zum neuen Bildset.

Beispiele

Dieses Codebeispiel erstellt ein Bildset, das durch Firma, Ordner, Name und Typ angegeben wird. Die Antwort ist ein Asset-Handle des neu erstellten Bildsets.

Anfrage

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

Antwort

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

recommendation-more-help