DocumentatieDynamic Media Image Production System API

createMetadataField

Laatst bijgewerkt: 1 september 2023
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
  • Beheerder

Met deze methode kunnen beheerders metagegevensvelden maken voor coördinatie met inhoudsbeheersystemen of voor sjabloonbewerkingen. Voorbeelden van gemaakte metagegevensvelden zijn trefwoorden, informatie over de auteur van de afbeelding of informatie over de copyrighthouder.

Syntaxis

Geautoriseerde gebruikerstypen

  • IpsAdmin

Parameters

Input (createMetadataFieldParam)

ParameternaamTypeVereistBeschrijving
companyNamexsd:tekenreeksJaDe naam van het bedrijf waartoe het metagegevensveld behoort.
assetTypexsd:tekenreeksJaElementtype.
namexsd:tekenreeksJaNaam van het metagegevensveld dat u maakt.
fieldTypexsd:tekenreeksJa

Type metagegevensveld.

De constante typen metagegevensvelden definieert de beschikbare typen.

defaultValuexsd:tekenreeksNee

De standaardwaarde van het metagegevensveld dat moet worden gemaakt (bijvoorbeeld Scène 7).

Standaardwaarden worden niet ondersteund voor typen tagvelden en moeten worden weggelaten. Als een niet-lege standaardinstelling is opgegeven voor een type tagveld, wordt een fout geretourneerd.

isHiddenxsd:BooleanNeeDe huid of stelt IPS systeem-specifieke meta-gegevens bloot.
isEnforcexsd:BooleanNee

Een Booleaanse markering die aangeeft of het metagegevensveld wordt afgedwongen (gevalideerd) wanneer de waarde wordt ingesteld.

Indien ingesteld op true, wordt een fout gegenereerd als een ongeldige waarde is ingesteld in setAssetMetadata / batchSetAssetMetadata.

initialTagValuexsd:tekenreeksNeeHiermee kunt u een set gedeelde specifieke waarden maken waarnaar geselecteerde tags kunnen verwijzen.

Output (createMetadataFieldReturn)

NaamTypeVereistBeschrijving
fieldHandlexsd:stringJaDe greep naar het nieuwe metagegevensveld.

Voorbeelden

In dit codevoorbeeld wordt een metagegevensveld voor tekenreekstypen gemaakt met de naam createMetadataField. De reactie keert de handvat op het nieuwe meta-gegevensgebied terug.

Verzoek

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

Antwoord

<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