Objet modèle

Les objets suivants sont directement liés à l’API template.

Modèle

L'objet modèle possède les propriétés suivantes.

Propriété Type Description
templateid ID ID du modèle.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
description text Description du modèle.
host string Nom technique du modèle.

Comportement de la propriété :
- obligatoire pour les opérations de création
name string Nom visible du modèle.

Par défaut : valeur de la propriété host.
readme text Instructions de configuration spécifiques au modèle à afficher dans l'assistant hôte. Prend en charge le formatage Markdown.
uuid string Identifiant universel unique, utilisé pour lier les modèles importés à ceux qui existent déjà. Généré automatiquement s'il n'est pas fourni.
vendor_name string Nom du fournisseur du modèle.

Pour les opérations de création, vendor_name et vendor_version doivent soit être définis tous les deux, soit être laissés vides. Pour les opérations de mise à jour, vendor_version peut être laissé vide s'il possède une valeur dans la base de données.
vendor_version string Version du fournisseur du modèle.

Pour les opérations de création, vendor_name et vendor_version doivent soit être définis tous les deux, soit être laissés vides. Pour les opérations de mise à jour, vendor_name peut être laissé vide s'il possède une valeur dans la base de données.
wizard_ready integer Indique si le modèle est disponible pour la sélection dans l'assistant hôte.

Valeurs possibles :
0 - (par défaut) Non disponible.
1 - Disponible.

Étiquette de modèle

L’objet d’étiquette de modèle possède les propriétés suivantes.

Propriété Type Description
tag string Nom de l’étiquette de modèle.

Comportement de la propriété :
- obligatoire.
value string Valeur de l’étiquette de modèle.

Étiquette de modèle héritée

L'objet d'étiquette de modèle héritée possède les propriétés suivantes.

Property Type Description
tag string Nom de l'étiquette.

Comportement de la propriété:
- en lecture seule
- obligatoire.
value string Valeur de l'étiquette.

Comportement de la propriété:
- en lecture seule.
object integer Type d'objet dont l'étiquette a été héritée.

Valeurs possibles :
0 - modèle.

Comportement de la propriété:
- en lecture seule.
objectid ID ID de l'objet dont l'étiquette a été héritée.

Comportement de la propriété:
- en lecture seule.