Obtenir les détails du modèle

GET /esignglobal/v1/templates/templateDetail

Description de l'interface

Récupérer les informations des contrôles dans le modèle.

Via le numéro de modèle de contrattemplateIdpour obtenir les informations des contrôles de remplissage définis dans le modèle, qui peuvent ensuite être utilisés via l'interfaceRemplir le modèle pour générer un fichier pour remplir le modèle.

Paramètres de requête

Nom du paramètre	Type	Obligatoire	Description
templateId	string	true	ID du modèle de contrat, peut être consulté dans la liste des modèles d'eSignGlobal

Exemple de requête

GET  https:// … …/esignglobal/v1/templates/templateDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

Paramètres de réponse

Nom du paramètre				Type	Description
templateId				string	ID du modèle de contrat
templateName				string	Nom du modèle de contrat
templateType				int	Type de modèle de contrat : 0-PDF, 1-WORD
createTime				string	Date de création du modèle de contrat (format d’horodatage Unix, unité : millisecondes)
updateTime				string	Date de mise à jour du modèle de contrat (format d’horodatage Unix, unité : millisecondes)
templateStatus				int	État du modèle de contrat : 0-Désactivé, 1-Activé
fields				array	Informations de la liste des contrôles dans le modèle
	fieldId			string	ID du contrôle (généré automatiquement par le système eSignGlobal lors de la configuration du modèle de contrat)
	fieldKey			string	Clé du contrôle (définie par l’utilisateur lors de la configuration du modèle de contrat)
	fieldName			string	Nom du contrôle
	required			boolean	Le contrôle est-il obligatoire : True - Obligatoire, false - Non obligatoire
	fieldType			string	1 - Texte sur une seule ligne, 2 - Nombre, 3 - Date, 8 - Texte multiligne, 9 - Case à cocher, 10 - Bouton radio, 11 - Image, 14 - Liste déroulante, 15 - Case à cocher
	fieldPosition			object	Informations sur la position du contrôle (retournées uniquement par le modèle PDF)
		posX		float	Abscisse X de la position du contrôle
		posY		float	Ordonnée Y de la position du contrôle
		posNo		int	Page où se trouve le contrôle
		movable		boolean	Autoriser le déplacement de l'emplacement lors de la signature, false par défaut false - N'autorise pas le signataire à ajuster la position de son propre contrôle de signature true - Autorise le signataire à ajuster la position de son propre contrôle de signature
	fieldSpecialAttribute			object	Propriétés spécifiques au contrôle
		dateFormat		string	Format de date (spécifique au contrôle de date)
		imageType		string	Type d'image (spécifique au contrôle d'image)
		options		array	Options (spécifique aux contrôles de liste déroulante, aux contrôles radio et aux contrôles de cases à cocher)
			optionContent	string	Contenu de l'option
			optionOrder	int	Ordre des options
			selected	boolean	L'option est-elle sélectionnée par défaut ?
		numberFormat		string	Format numérique (spécifique au contrôle numérique), format comme suit : 0 - entier, 0.0 - conserve une décimale, 0.00 - conserve deux décimales
		tableContent		array	Contenu des lignes et des colonnes du tableau (spécifique au contrôle de tableau dynamique), format : [row{"column1":"value1","column2":"value2"}] Remarques : row représente la ligne correspondante du tableau dynamique, le nombre de row dépend du modèle Nombre de lignes ajoutées dans le contrôle de tableau dynamique. column1 représente la valeur de clé de la cellule dans la ligne actuelle, value1 représente la valeur de la cellule dans la ligne actuelle. Si la cellule n’a pas de valeur fixe définie, il s’agit d’une chaîne vide "", sinon il s’agit de la valeur fixe définie. Voir l’explication de tableContent pour plus de détails.
		fieldMaxLength		string	Limite supérieure de la longueur pouvant être remplie, unité : caractères chinois 【注】1 caractère chinois = 2 caractères anglais ;
	fieldSize			object	Taille du contrôle
		fieldWidth		float	Largeur du contrôle (distance gauche-droite du rectangle, en px)
		fieldHeight		float	Hauteur du contrôle (distance haut-bas du rectangle, en px)

Exemple de réponse

{
    "code": "0",
    "data ": {
        "createTime": 1693910774808,
        "fields": [
            {
                "fieldId": "7e4bbdb838f64a31b0a4bdea18d1613c",
                "fieldKey": "",
                "fieldName": "身份证号 ",
                "fieldPosition": null,
                "fieldSize": {
                    "fieldHeight": "",
                    "fieldWidth": ""
                },
                "fieldSpecialAttribute": {
                    "dateFormat": "yyyy/MM/dd ",
                    "fieldMaxLength": "",
                    "imageType": "",
                    "numberFormat": "",
                    "options": [

                    ],
                    "tableContent": [

                    ]
                },
                "fieldType": 3,
                "required": false
            }
        ],
        "templateId": "d288b477-ed3c-4fe6-801c-80d8ec5fe9cf",
        "templateName": "test123456 ",
        "templateStatus": 0,
        "updateTime": 1693911131351
    },
    "message": "成功 "
}