Recupera i dettagli del controllo del modello del firmatario

GET/esignglobal/v1/templates/signerFieldsDetail

Descrizione dell'interfaccia

Interroga le informazioni sui controlli dei firmatari nel modello.

Attraverso l'ID del modello contrattualetemplateIdper ottenere le informazioni sui controlli dei firmatari impostati nel modello, successivamente è possibile utilizzareper avviare rapidamente una bustainterfaccia per avviare la busta.

Parametri di richiesta

Nome del parametro	Tipo	Obbligatorio	Descrizione
templateId	string	true	ID del modello contrattuale, consultabile nella gestione dei modelli di SaaS

Esempio di richiesta

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

Parametri di risposta

Nome del parametro				Tipo	Descrizione
templateId				string	ID del modello di contratto
templateName				string	Nome del modello di contratto
documentFields				array	Elenco dei controlli file
	fieldType			string	Elenco dei controlli per le dimensioni del file. Utilizzato per aggiungere controlli per le dimensioni del file non associati a firmatari su un file specifico.
	pageNo			string	Tipo di controllo. Inserire eMeterai per indicare il controllo per la tassa di bollo indonesiana.
	posX			float	Numero di pagina in cui si trova il controllo. Il controllo per la tassa di bollo indonesiana supporta solo una singola pagina; è necessario inserire un numero di pagina singolo, non sono supportati formati come 1-3 o 1,3 che indicano pagine multiple continue o non consecutive.
	posY			float	Spostamento sull'asse x, con l'origine delle coordinate nell'angolo in basso a sinistra della pagina. L'intervallo delle coordinate è coerente con quello degli altri controlli.
signerFields				array	Informazioni relative all'elenco dei controlli per i firmatari nel modello
	signConfigs			array	Informazioni sul controllo di firma
		fieldId		string	ID del controllo (generato automaticamente dal sistema durante la configurazione del modello di contratto)eSignGlobal
		fieldKey		string	Chiave del controllo (definita dall'utente durante la configurazione del modello di contratto)
		fieldType		string	Tipo di controllo: signature-Area di firma stamp-Area del timbro approval-Controllo di approvazione
		required		boolean	Obbligatorio o meno, obbligatorio per impostazione predefinita true-Obbligatorio false-Non obbligatorio
		sizeRule		string	Modalità di visualizzazione delle dimensioni dell'area di firma originalSize-Applicare il timbro in base alle dimensioni effettive della firma/timbro targetSize-Definire manualmente larghezza e altezza dell'area di firma/timbro
		height		int	Altezza del controllo di firma
		width		int	Larghezza del controllo di firma
		movable		boolean	Consenti lo spostamento durante la firma false-Non consentire al firmatario di modificare la posizione del proprio controllo di firma true-Consentire al firmatario di modificare la posizione del proprio controllo di firma
		allowedOptions		array	Opzioni consentite per l'approvazione da parte del firmatario, applicabili quando fieldType è approval. Il valore predefinito è ["approve", "decline"] approve-Accetta decline-Rifiuta
		posX		float	Coordinate X della posizione del controllo
		posY		float	Posizione del controlloYCoordinate Y
		pageNo		string	Numero di pagina in cui si trova il controllo
	fillConfigs			array	Informazioni sul controllo di firma
		fieldId		string	ID del controllo (generato automaticamente dal sistema durante la configurazione del modello di contratto)eSignGlobal
		fieldKey		string	Chiave del controllo (definita dall'utente durante la configurazione del modello di contratto)
		fieldName		string	Nome del controllo
		required		boolean	Obbligatorio true-Obbligatorio false-Non obbligatorio
		fieldsType		string	Tipo di controllo: 1-Testo su una riga 15-Casella di controllo
		textField		object	Proprietà del controllo testo
			overflowType	int	Valido solo per text 1-Riduzione automatica della dimensione del carattere 2-Limitazione dell'immissione
			minFontSize	float	Valido solo per text, valido solo quando 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	Larghezza del controllo
			fontSize	float	Valido solo per text, dimensione del carattere 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	Valido solo per text, colore esadecimale
			bold	boolean	Valido solo per text, se il carattere è in grassetto true-Grassetto false-Non grassetto
			italic	boolean	Valido solo per text, se il carattere è in corsivo true-Corsivo false-Non corsivo
			underline	boolean	Si applica solo al testo, indica se aggiungere la sottolineatura al font true-Aggiungi sottolineatura false-Non aggiungere sottolineatura
			lineThrough	boolean	Si applica solo al testo, indica se aggiungere il barrato true-Aggiungi barrato false-Non aggiungere barrato
			horizontalAlignment	string	Si applica solo al testo, formato di allineamento orizzontale al centro LEFT-Allinea a sinistra CENTER-Centra RIGHT-Allinea a destra
		tickBoxField		object	Proprietà della casella di controllo
			tickOptions	array	Si applica solo a Check 1-Spunta 2-X
		posX		float	Coordinate X della posizione del controllo
		posY		float	Posizione del controlloYCoordinate Y
		pageNo		string	Numero di pagina in cui si trova il controllo
	signDateConfigs			array	Informazioni sulla data di firma
		fieldId		string	ID del controllo (generato automaticamente dal sistema durante la configurazione del modello di contratto)eSignGlobal
		fieldKey		string	Chiave del controllo (definita dall'utente durante la configurazione del modello di contratto)
		movable		boolean	Consenti lo spostamento della posizione durante la firma false- Non consentire al firmatario di regolare la posizione dei propri controlli di firma true- Consenti al firmatario di regolare la posizione dei propri controlli di firma
		posX		float	Coordinate X della posizione del controllo
		posY		float	Posizione del controlloYCoordinate Y
		pageNo		string	Numero di pagina in cui si trova il controllo
		signDateFormat		string	Formato della data di firma

Esempio di risposta

{
    "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"
}