DokumentationDynamic Media Image Production System-API

createMetadataField createmetadatafield

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Damit können Administratoren Metadatenfelder erstellen, um sie mit Content Management-Systemen oder für Vorlagenvorgänge zu koordinieren. Beispiele für erstellte Metadatenfelder sind Suchbegriffe, Informationen zum Autor des Bildes oder Informationen zum Urheberrechtsinhaber.

Syntax

Autorisierte Benutzertypen section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

Parameter section-f8260bc8dd0a4570bc7f714f81ab975f

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

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 der Wert auf "true"gesetzt ist, wird ein Fehler ausgegeben, wenn ein illegaler Wert in setAssetMetadata / batchSetAssetMetadata festgelegt ist.

initialTagValue
xsd:string
Nein
Damit können Sie eine Reihe gemeinsamer spezifischer Werte erstellen, auf die ausgewählte Tags verweisen können.

Output (createMetadataFieldReturn)

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

Beispiele section-ba66be30f36b4aeba1bc721b0b92fdfc

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.

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