DokumentationDynamic Media Image Production System-API

createMetadataField

Letzte Aktualisierung: 30. Dezember 2024
  • Themen:

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)

ParameternameTypErforderlichBeschreibung
companyNamexsd:stringJaDer Name des Unternehmens, zu dem das Metadatenfeld gehört.
assetTypexsd:stringJaAsset-Typ
Namexsd:stringJaName des Metadatenfelds, das Sie erstellen.
fieldTypexsd:stringJa

Metadaten-Feldtyp.

Die Konstante Metadatenfeldtypen definiert die verfügbaren Typen.

defaultValuexsd:stringNein

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.

isHiddenxsd:BooleanNeinIPS-systemspezifische Metadaten aus- oder einblenden.
isEnforcexsd:BooleanNein

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.

initialTagValuexsd:stringNeinDamit können Sie einen Satz gemeinsam genutzter spezifischer Werte erstellen, auf die ausgewählte Tags verweisen können.

Ausgabe (createMetadataFieldReturn)

NameTypErforderlichBeschreibung
fieldHandlexsd:stringJaDas 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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681