createMetadataField

Última actualización: 2023-09-01
  • Creado para:
  • Developer
    Admin

Permite a los administradores crear campos de metadatos para coordinarlos con los sistemas de administración de contenido o para operaciones de plantilla. Algunos ejemplos de campos de metadatos creados son palabras clave, información sobre el autor de la imagen o información sobre el titular del copyright.

Sintaxis

Tipos de usuarios autorizados

  • IpsAdmin

Parámetros

Entrada (createMetadataFieldParam)

Nombre del parámetro Tipo Obligatorio Descripción
companyName xsd:string Sí El nombre de la empresa a la que pertenece el campo de metadatos.
assetType xsd:string Sí Tipo de recurso.
name xsd:string Sí Nombre del campo de metadatos que está creando.
fieldType xsd:string Sí Tipo de campo de metadatos.

La constante de tipos de campo de metadatos define los tipos disponibles.

defaultValue xsd:string No

El valor predeterminado del campo de metadatos que se va a crear (por ejemplo, Scene7).

Los valores predeterminados no son compatibles con los tipos de campos de etiqueta y deben omitirse. Si se especifica un valor predeterminado no vacío para un tipo de campo de etiqueta, se devuelve un error.

isHidden xsd:boolean No Oculte o exponga metadatos específicos del sistema IPS.
isEnforced xsd:boolean

No

Un indicador booleano que indica si el campo de metadatos se fuerza (valida) cuando se establece el valor.

Si se establece en true, se genera un error si se establece un valor no válido en setAssetMetadata / batchSetAssetMetadata.

initialTagValue xsd:string No Permite crear un conjunto de valores específicos compartidos a los que pueden apuntar las etiquetas seleccionadas.

Salida (createMetadataFieldReturn)

Nombre Tipo Obligatorio Descripción
fieldHandle xsd:string Sí El identificador del nuevo campo de metadatos.

Ejemplos

Este ejemplo de código crea un campo de metadatos de tipo cadena denominado createMetadataField. La respuesta devuelve el identificador al nuevo campo de metadatos.

Solicitar

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

Respuesta

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

En esta página