DokumentationDynamic Media Image Production System API

createMetadataField createmetadatafield

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Det gör att administratörer kan skapa metadatafält som kan koordineras med content management-system eller för mallåtgärder. Exempel på skapade metadatafält är nyckelord, information om författaren till bilden eller information om upphovsrättsinnehavare.

Syntax

Auktoriserade användartyper section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

Parametrar section-f8260bc8dd0a4570bc7f714f81ab975f

Indata (createMetadataFieldParam)

Parameternamn
Typ
Obligatoriskt
Beskrivning
companyName
xsd:string
Ja
Namnet på det företag som metadatafältet tillhör.
assetType
xsd:string
Ja
Resurstyp.
name
xsd:string
Ja
Namnet på metadatafältet som du skapar.
fieldType
xsd:string
Ja

Fälttyp för metadata.

Metadatafältstyperna definierar de tillgängliga typerna.

defaultValue
xsd:string
Nej

Standardvärdet för metadatafältet som ska skapas (till exempel Scen 7).

Standardvärden stöds inte för taggfältstyper och måste utelämnas. Om ett icke-tomt standardvärde anges för en taggfältstyp returneras ett fel.

isHidden
xsd:boolesk
Nej
Dölj eller visa systemspecifika IPS-metadata.
isEnforced
xsd:boolesk
Nej

En boolesk flagga som anger om metadatafältet används (valideras) när värdet ställs in.

Om värdet är true genereras ett fel om ett ogiltigt värde anges i setAssetMetadata / batchSetAssetMetadata .

initialTagValue
xsd:string
Nej
Du kan skapa en uppsättning delade specifika värden som markerade taggar kan peka på.

Utdata (createMetadataFieldReturn)

Namn
Typ
Obligatoriskt
Beskrivning
fieldHandle
xsd:string
Ja
Referensen till det nya metadatafältet.

Exempel section-ba66be30f36b4aeba1bc721b0b92fdfc

Detta kodexempel skapar ett metadatafält för strängtyp med namnet createMetadataField. Svaret returnerar referensen till det nya metadatafältet.

Begäran

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

Svar

<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