createMetadataField

允許管理員建立新的元資料欄位以與內容管理系統或模板操作協調。 建立的元資料欄位的示例包括關鍵字、關於影像作者的資訊或版權持有人資訊。

語法

授權用戶類型

  • IpsAdmin

參數

輸入(createMetadataFieldParam)

參數名稱 類型 必要 說明
公司名稱 xsd:string 是 元資料欄位所屬的公司的名稱。
資產類型 xsd：字串 是 資產類型.
名稱 xsd：字串 是 正在建立的元資料欄位的名稱。
欄位類型 xsd：字串 是 元資料欄位類型。

元資料欄位類型常數定義可用類型。

defaultValue xsd：字串 否

要建立的元資料欄位的預設值(例如， 場景7)。

標籤欄位類型不支援預設值，必須省略。 如果為標籤欄位類型指定了非空預設值，則返回錯誤。

隱藏 xsd:boolean 否 隱藏或公開IPS系統特定的元資料。
強制 xsd：布爾

否

一個布爾標誌，指示在設定值時是否強制（驗證）元資料欄位。

如果設定為true，則如果在中設定了非法值，則會拋出錯誤 setAssetMetadata / batchSetAssetMetadata。

初始標籤值 xsd：字串 否 允許您建立一組共用枚舉值，選定標籤可以指向這些值。

輸出(createMetadataFieldReturn)

名稱 類型 必要 說明
欄位句柄 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>

本頁內容