Obtenir les détails du contrôle de modèle de signataire

GET/esignglobal/v1/templates/signerFieldsDetail

Description de l'interface

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

Via le numéro de modèle de contrattemplateIdpour obtenir les informations des contrôles de signataire définis dans le modèle, qui peuvent ensuite être utilisées viaLancer rapidement une enveloppel'interface pour lancer une enveloppe.

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 gestion des modèles SaaS

Exemple de requête

GET  https:// … …/esignglobal/v1/templates/signerFieldsDetail?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
signerFields				array	Informations sur la liste des contrôles de signataire dans le modèle
	signConfigs			array	Informations sur le contrôle de signature
		fieldId		string	ID du contrôle (défini lors de la configuration du modèle de contrat par leeSignGlobalsystème automatiquement)
		fieldKey		string	Clé du contrôle (définie par l'utilisateur lors de la configuration du modèle de contrat)
		fieldType		string	Type de contrôle : signature- Zone de signature stamp- Zone de sceau approval- Contrôle d'approbation
		sizeRule		string	Méthode d'affichage de la taille de la zone de signature originalSize- Appliquer le sceau en fonction de la taille réelle de la signature/du sceau targetSize- Définir la largeur et la hauteur de la zone de signature/de sceau
		height		int	Hauteur du contrôle de signature
		width		int	Largeur du contrôle de signature
		movable		boolean	Autoriser le déplacement de la position lors de la signature false- Ne pas autoriser le signataire à ajuster la position de son propre contrôle de signature true- Autoriser le signataire à ajuster la position de son propre contrôle de signature
		allowedOptions		array	Options autorisées pour l'approbation par le signataire, applicables lorsque fieldType est approval. La valeur par défaut est ["approve", "decline"] approve- Approuver decline- Refuser
		posX		float	Coordonnée X de la position du contrôle
		posY		float	Position du contrôleYCoordonnée Y
		pageNo		string	Numéro de page où se trouve le contrôle
	fillConfigs			array	Informations sur le contrôle de signature
		fieldId		string	ID du contrôle (généré automatiquement par leeSignGlobalsystème 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	Obligatoire ou non true-Obligatoire false-Non obligatoire
		fieldsType		string	Type de contrôle : 1-Texte sur une seule ligne 15- Case à cocher
		textField		object	Propriétés du contrôle de texte
			overflowType	int	S'applique uniquement au texte 1- Réduire automatiquement la taille de la police 2- Limiter la saisie
			minFontSize	float	S'applique uniquement au texte, et uniquement si overflowType=1. 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			width	float	Largeur du contrôle
			fontSize	float	S'applique uniquement au texte, taille de la police 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			textColor	string	S'applique uniquement au texte, couleur hexadécimale
			bold	boolean	S'applique uniquement au texte, police en gras ou non true-Gras false-Pas gras
			italic	boolean	S'applique uniquement au texte, est-ce en italique true-Italique false-Non italique
			underline	boolean	S'applique uniquement au texte, le texte doit-il être souligné true-Souligner false-Ne pas souligner
			lineThrough	boolean	S'applique uniquement au texte, faut-il ajouter une barre de suppression true-Ajouter une barre de suppression false-Ne pas ajouter de barre de suppression
			horizontalAlignment	string	S'applique uniquement au texte, format de centrage horizontal LEFT-Aligné à gauche CENTER-Centré RIGHT-Aligné à droite
		tickBoxField		object	Attribut de case à cocher
			tickOptions	array	Ne s'applique qu'à Check 1- Coche 2- Croix
		posX		float	Coordonnée X de la position du contrôle
		posY		float	Position du contrôleYCoordonnée Y
		pageNo		string	Page où se trouve le contrôle
	signDateConfigs			array	Informations sur la date de signature
		fieldId		string	ID du contrôle (généré automatiquement par leeSignGlobalsystème 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)
		movable		boolean	Autoriser le déplacement de la position lors de la signature false- Ne pas autoriser le signataire à ajuster la position de son propre contrôle de signature true- Autoriser le signataire à ajuster la position de son propre contrôle de signature
		posX		float	Coordonnée X de la position du contrôle
		posY		float	Position du contrôleYCoordonnée Y
		pageNo		string	Numéro de page où se trouve le contrôle
		signDateFormat		string	Format de la date de signature

Exemple de réponse

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}