Show Menu
TOPICS×

createMetadataField

Lets administrators create new 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 name Type Required Description
companyName xsd:string Yes Name of the company the metadata field belongs to.
assetType xsd:string Yes Asset type.
name xsd:string Yes Name of the metadata field that you are creating.
fieldType xsd:string Yes Metadata field type.
The metadata field types constant defines the available types.
defaultValue xsd:string No
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 will be returned.
isHidden xsd:boolean No Hide or expose IPS system-specific metadata.
isEnforced xsd:boolean
No
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 .
initialTagValue xsd:string No Allows you create a set of shared enumerated values that selected tags can point to.
Output (createMetadataFieldReturn)
Name
Type
Required
Description
* fieldHandle *
xsd:string
Yes
The 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>