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

GET/esignglobal/v1/templates/signerFieldsDetail

Description de l'interface

Interroger les informations des widgets de signataire dans le modèle.

Via l'ID du modèle de contrattemplateIdpour obtenir les informations des widgets de signataire configurés dans le modèle, puis utiliser ultérieurementl'interfacepour initier un enveloppe.

Paramètres de requête

Nom du paramètre	Type	Obligatoire	Description
templateId	string	true	ID du modèle de contrat, consultable dans la gestion des modèles de 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
documentFields				array	Liste des contrôles de fichier
	fieldType			string	Liste des contrôles dimensionnels de fichier. Utilisée pour ajouter des contrôles dimensionnels de fichier non liés à un signataire sur un fichier spécifié.
	pageNo			string	Type de contrôle. Indiquez eMeterai pour le contrôle de timbre fiscal indonésien.
	posX			float	Numéro de page où se trouve le contrôle. Le contrôle de timbre fiscal indonésien ne prend en charge que la spécification d'une seule page ; il faut transmettre un numéro de page unique, les formats multiples continus ou discontinus tels que 1-3 ou 1,3 ne sont pas pris en charge.
	posY			float	Décalage selon l'axe x, l'origine des coordonnées étant le coin inférieur gauche de la page. La plage de coordonnées est identique à celle des autres contrôles.
signerFields				array	Informations relatives à 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 (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)
		fieldType		string	Type de contrôle : signature-Zone de signature stamp-Zone de cachet approval-Contrôle d'approbation
		required		boolean	Champ obligatoire, par défaut obligatoire true-Obligatoire false-Non obligatoire
		sizeRule		string	Mode d'affichage des dimensions de la zone de signature originalSize-Placement du cachet selon les dimensions réelles de la signature/cachet targetSize-Largeur et hauteur personnalisées de la zone de signature/cachet
		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-Le signataire ne peut pas modifier la position de son propre contrôle de signature true-Le signataire peut modifier la position de son propre contrôle de signature
		allowedOptions		array	Options autorisant le signataire à approuver, applicable lorsque fieldType est 'approval'. Par défaut : ["approve", "decline"] approve-Accepter decline-Refuser
		posX		float	Coordonnée X de la position du contrôle
		posY		float	Position du contrôleYOrdonnée
		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 type text 1-Réduction automatique de la taille de police 2-Limite d'entrée
			minFontSize	float	S'applique uniquement au type text, et seulement lorsque 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 type text, taille de 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 type text, couleur hexadécimale
			bold	boolean	S'applique uniquement au type text, graisse de la police true-Gras false-Pas de gras
			italic	boolean	S'applique uniquement au type text, italique true-Italique false-Non italique
			underline	boolean	S'applique uniquement au texte, indique si le soulignement doit être ajouté à la police true-Ajouter un soulignement false-Ne pas ajouter de soulignement
			lineThrough	boolean	S'applique uniquement au texte, indique si une barre oblique doit être ajoutée true-Ajouter une barre oblique false-Ne pas ajouter de barre oblique
			horizontalAlignment	string	S'applique uniquement au texte, format centré horizontalement LEFT-Aligné à gauche CENTER-Centré RIGHT-Aligné à droite
		tickBoxField		object	Propriétés de la case à cocher
			tickOptions	array	S'applique uniquement à Check 1-Cocher 2-X
		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
	signDateConfigs			array	Informations sur la date de signature
		fieldId		string	ID du contrôle (généré automatiquement par le système lors de la configuration du modèle de contrat)eSignGlobal
		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- Le signataire ne peut pas ajuster la position de son propre contrôle de signature true- Le signataire peut 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"
}