createMetadataField

Ermöglicht Administratoren das Erstellen neuer Metadatenfelder zur Koordinierung mit Content Management-Systemen oder für Vorlagenvorgänge. Beispiele für erstellte Metadatenfelder sind Suchbegriffe, Informationen zum Autor des Bildes oder Informationen zum Urheberrechtsinhaber.

Syntax

Autorisierte Benutzertypen

  • IpsAdmin

Parameter

Eingabe (createMetadataFieldParam)

Parametername Typ Erforderlich Beschreibung
companyName xsd:string Ja Name des Unternehmens, zu dem das Metadatenfeld gehört.
assetType xsd:string Ja Asset-Typ.
name xsd:string Ja Name des Metadatenfelds, das Sie erstellen.
fieldType xsd:string Ja Metadatenfeldtyp.

Die Konstante für Metadatenfeldtypen definiert die verfügbaren Typen.

defaultValue xsd:string Nein

Der Standardwert des zu erstellenden Metadatenfelds (z. B. Scene 7).

Standardwerte werden für Tag-Feldtypen nicht unterstützt und müssen weggelassen werden. Wenn für einen Tag-Feldtyp ein nicht leerer Standardwert angegeben ist, wird ein Fehler zurückgegeben.

isHidden xsd:boolean Nein Ausblenden oder Anzeigen von IPS-systemspezifischen Metadaten.
isEnforced xsd:boolean

Nein

Eine boolesche Kennzeichnung, die anzeigt, ob das Metadatenfeld erzwungen (validiert) wird, wenn der Wert festgelegt wird.

Wenn "true"festgelegt ist, wird ein Fehler ausgegeben, wenn ein illegaler Wert in setAssetMetadata / batchSetAssetMetadata festgelegt ist.

initialTagValue xsd:string Nein Ermöglicht die Erstellung eines Satzes gemeinsamer Auflistungswerte, auf den ausgewählte Tags verweisen können.

Ausgabe (createMetadataFieldReturn)

Name Typ Erforderlich Beschreibung
*fieldHandle* xsd:string Ja Der Handle für das neue Metadatenfeld.

Beispiele

In diesem Codebeispiel wird ein Metadatenfeld vom Typ Zeichenfolge mit dem Namen createMetadataField erstellt. Die Antwort gibt den Handle an das neue Metadatenfeld zurück.

Anforderung

<createMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <assetType>Image</assetType>
   <name>createMetadataField</name>
   <fieldType>String</fieldType>
   <initialTagValue>Fall</initialTagValue>
   <defaultValue>Default</defaultValue>
</createMetadataFieldParam>

Antwort

<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>

Auf dieser Seite