createMetadataField
Créé pour :
- Développeur
- Administration
Il permet aux administrateurs de créer des champs de métadonnées pour les coordonner avec les systèmes de gestion de contenu ou pour les opérations de modèle. Parmi les exemples de champs de métadonnées créés, citons les mots-clés, les informations sur l’auteur de l’image ou les informations sur le titulaire du copyright.
Syntaxe
Types d’utilisateurs autorisés
IpsAdmin
Paramètres
Entrée (createMetadataFieldParam)
| Nom du paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| companyName | xsd:string | Oui | Nom de la société à laquelle le champ de métadonnées appartient. |
| assetType | xsd:string | Oui | Type de ressource. |
| name | xsd:string | Oui | Nom du champ de métadonnées que vous créez. |
| fieldType | xsd:string | Oui |
Type de champ de métadonnées. La constante Types de champ de métadonnées définit les types disponibles. |
| defaultValue | xsd:string | Non |
La valeur par défaut du champ de métadonnées à créer (par exemple, Scene 7). Les valeurs par défaut ne sont pas prises en charge pour les types de champ de balise et doivent être omises. Si une valeur par défaut non vide est spécifiée pour un type de champ de balise, une erreur est renvoyée. |
| isHidden | xsd:boolean | Non | Masquer ou exposer les métadonnées spécifiques au système IPS. |
| isEnforced | xsd:boolean | Non |
Indicateur boolean qui indique si le champ de métadonnées est appliqué (validé) lorsque la valeur est définie. Si la valeur est définie sur true, une erreur est générée si une valeur non autorisée est définie dans setAssetMetadata / batchSetAssetMetadata. |
| initialTagValue | xsd:string | Non | Il vous permet de créer un ensemble de valeurs spécifiques partagées auxquelles les balises sélectionnées peuvent pointer. |
Sortie (createMetadataFieldReturn)
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| fieldHandle | xsd:string | Oui | Gestion du nouveau champ de métadonnées. |
Exemples
Cet exemple de code crée un champ de métadonnées de type chaîne appelé createMetadataField. La réponse renvoie la poignée au nouveau champ de métadonnées.
Requête
<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>
Réponse
<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>