DocumentationDynamic Media Image Production System API

saveMetadataField

Last update: Thu Aug 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Create or edit a metadata field. Omit the optional field handle to create a metadata field.

NOTE
This method is deprecated.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (saveMetadataFieldParam)

Parameter name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company.
fieldHandle
xsd:string
No
Field handle.
assetType
xsd:string
Yes
Choice of asset types from which to save metadata.
name
xsd:string
Yes
Field name.
fieldType
xsd:string
Yes
Choice of metadata field types.
defaultValue
xsd:string
Yes
Default value of the fields for all assets.
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.

Output (saveMetadataFieldReturn)

Name
Type
Required
Description
fieldHandle
xsd:string
Yes
Handle of the new metadata field.

Examples

This code sample creates a metadata field constrained by the Asset Type and Metadata Field Types string constants. If the fieldHandle element has a valid field handle value, it changes the metadata values and gets the same field handle that you specified in the request.

Request

<ns1:saveMetadataFieldParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:assetType>Pdf</ns1:assetType>
   <ns1:name>Resolution</ns1:name>
   <ns1:fieldType>String</ns1:fieldType>
   <ns1:defaultValue>120</ns1:defaultValue>
</ns1:saveMetadataFieldParam>

Response

<saveMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <fieldHandle>47|ALL|Resolution</fieldHandle>
</saveMetadataFieldReturn>
4e9b9d8c-5839-4215-aa35-01b652869681