createMetadataField

允许管理员创建新的元数据字段以与内容管理系统协调或用于模板操作。 创建的元数据字段的示例包括关键字、有关图像作者的信息或版权持有者信息。

语法

授权用户类型

  • IpsAdmin

参数

输入(createMetadataFieldParam)

参数名称 类型 必需 说明
companyName xsd:string 元数据字段所属的公司的名称。
assetType xsd:string 资源类型.
name xsd:string 要创建的元数据字段的名称。
fieldType xsd:string 元数据字段类型。

元数据字段类型常量定义可用类型。

defaultValue xsd:string

要创建的元数据字段的默认值(例如, Scene 7)。

标记字段类型不支持默认值,因此必须忽略默认值。 如果为标记字段类型指定了非空的默认值,则将返回错误。

isHidden xsd:boolean 隐藏或公开IPS系统特定的元数据。
isEnforced xsd:boolean

布尔标记,用于指示在设置值时是否强制(验证)元数据字段。

如果设置为true,则如果在 setAssetMetadata / batchSetAssetMetadata中设置了非法值,则会引发错误。

initialTagValue xsd:string 用于创建一组选定标记可以指向的共享枚举值。

Output(createMetadataFieldReturn)

名称 类型 必需 说明
*fieldHandle* xsd:string 新元数据字段的句柄。

示例

此代码示例将创建一个名为createMetadataField的字符串类型元数据字段。 响应会将句柄返回到新元数据字段。

请求

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

响应

<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>

在此页面上