DocumentatieDynamic Media Image Production System API

createMetadataField createmetadatafield

Last update: Fri Sep 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 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 section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

Parameters section-f8260bc8dd0a4570bc7f714f81ab975f

Input (createMetadataFieldParam)

Parameternaam
Type
Vereist
Beschrijving
companyName
xsd:tekenreeks
Ja
De naam van het bedrijf waartoe het metagegevensveld behoort.
assetType
xsd:tekenreeks
Ja
Elementtype.
name
xsd:tekenreeks
Ja
Naam van het metagegevensveld dat u maakt.
fieldType
xsd:tekenreeks
Ja

Type metagegevensveld.

De constante typen metagegevensvelden definieert de beschikbare typen.

defaultValue
xsd:tekenreeks
Nee

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.

isHidden
xsd:Boolean
Nee
De huid of stelt IPS systeem-specifieke meta-gegevens bloot.
isEnforce
xsd:Boolean
Nee

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.

initialTagValue
xsd:tekenreeks
Nee
Hiermee kunt u een set gedeelde specifieke waarden maken waarnaar geselecteerde tags kunnen verwijzen.

Output (createMetadataFieldReturn)

Naam
Type
Vereist
Beschrijving
fieldHandle
xsd:string
Ja
De greep naar het nieuwe metagegevensveld.

Voorbeelden section-ba66be30f36b4aeba1bc721b0b92fdfc

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