文档Dynamic Media Image Production System API

createMetadataField createmetadatafield

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员
  • 管理员

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

语法

授权用户类型 section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

参数 section-f8260bc8dd0a4570bc7f714f81ab975f

输入(createMetadataFieldParam)

参数名称
类型
必需
说明
公司名称
xsd：string
是
元数据字段所属公司的名称。
资产类型
xsd：string
是
资源类型。
名称
xsd：string
是
正在创建的元数据字段的名称。
fieldType
xsd：string
是

元数据字段类型。

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

defaultValue
xsd：string
否

要创建的元数据字段的默认值（例如，场景7）。

标记字段类型不支持默认值，必须省略。 如果为标记字段类型指定了非空默认值，则会返回错误。

isHidden
xsd：boolean
否
隐藏或公开IPS系统特定的元数据。
是强制的
xsd：boolean
否

布尔标记，指示在设置值时是否强制（验证）元数据字段。

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

initialTagValue
xsd：string
否
通过此选项可创建一组选定的标记可指向的共享特定值。

输出(createMetadataFieldReturn)

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

示例 section-ba66be30f36b4aeba1bc721b0b92fdfc

此代码示例创建一个名为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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681