createMetadataField
Erstellt für:
- Entwickler
- Admin
Damit können Admins Metadatenfelder erstellen, die mit Content-Management-Systemen oder für Vorlagenvorgänge koordiniert werden. Beispiele für erstellte Metadatenfelder sind Schlüsselwörter, Informationen über den Autor des Bildes oder Informationen über Urheberrechtsinhaber.
Syntax
Autorisierte Benutzertypen
IpsAdmin
Parameter
Eingabe (createMetadataFieldParam)
| Parametername | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| companyName | xsd:string | Ja | Der 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 |
Metadaten-Feldtyp. Die Konstante Metadatenfeldtypen definiert die verfügbaren Typen. |
| defaultValue | xsd:string | Nein |
Der Standardwert des zu erstellenden Metadatenfelds (z. B. Scene7). 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 | IPS-systemspezifische Metadaten aus- oder einblenden. |
| isEnforce | xsd:Boolean | Nein |
Ein boolesches Flag, das angibt, ob das Metadatenfeld erzwungen (validiert) wird, wenn der Wert festgelegt wird. Wenn auf „true“ gesetzt, wird ein Fehler ausgelöst, wenn in setAssetMetadata/ batchSetAssetMetadata ein unzulässiger Wert festgelegt ist. |
| initialTagValue | xsd:string | Nein | Damit können Sie einen Satz gemeinsam genutzter spezifischer Werte erstellen, auf die ausgewählte Tags verweisen können. |
Ausgabe (createMetadataFieldReturn)
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| fieldHandle | xsd:string | Ja | Das Handle zum neuen Metadatenfeld. |
Beispiele
Dieses Codebeispiel erstellt ein Metadatenfeld vom Typ Zeichenfolge mit dem Namen createMetadataField. Die Antwort gibt das Handle zum neuen Metadatenfeld zurück.
Anfrage
<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>