DocumentationDynamic Media Image Production System API

createMetadataField

Last update: August 31, 2023
  • Topics:
  • Dynamic Media Classic,SDK/API,Metadata

CREATED FOR:

  • Developer
  • Admin

It lets administrators create metadata fields to coordinate with content management systems or for template operations. Examples of created metadata fields include keywords, information about the author of the image, or copyright holder information.

Syntax

Authorized User Types

  • IpsAdmin

Parameters

Input (createMetadataFieldParam)

Parameter nameTypeRequiredDescription
companyNamexsd:stringYesThe name of the company that the metadata field belongs to.
assetTypexsd:stringYesAsset type.
namexsd:stringYesName of the metadata field that you are creating.
fieldTypexsd:stringYes

Metadata field type.

The metadata field types constant defines the available types.

defaultValuexsd:stringNo

The default value of the metadata field to be created (for example, Scene 7).

Default values are not supported for tag field types and must be omitted. If a non-empty default is specified for a tag field type, a fault is returned.

isHiddenxsd:booleanNoHide or expose IPS system-specific metadata.
isEnforcedxsd:booleanNo

A boolean flag that indicates whether the metadata field is enforced (validated) when the value is set.

If set to true, then a fault is thrown if an illegal value is set in setAssetMetadata / batchSetAssetMetadata.

initialTagValuexsd:stringNoIt lets you create a set of shared specific values that selected tags can point to.

Output (createMetadataFieldReturn)

NameTypeRequiredDescription
fieldHandlexsd:stringYesThe handle to the new metadata field.

Examples

This code sample creates a string type metadata field called createMetadataField. The response returns the handle to the new metadata field.

Request

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

Response

<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