Obtener detalles del control de plantilla del firmante

GET/esignglobal/v1/templates/signerFieldsDetail

Descripción de la interfaz

Consulte la información de los controles de firmante en la plantilla.

Mediante el número de identificación de la plantilla del contratotemplateIdpara obtener la información de los controles de firmante configurados en la plantilla, y posteriormente puedainiciar rápidamente un sobremediante la interfaz para iniciar un sobre.

Parámetros de solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
templateId	string	true	ID de la plantilla del contrato, que se puede consultar en la gestión de plantillas de SaaS

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro				Tipo	Descripción
templateId				string	ID de la plantilla del contrato
templateName				string	Nombre de la plantilla del contrato
documentFields				array	Lista de controles de archivos
	fieldType			string	Lista de controles de dimensiones de archivo. Se utiliza para agregar controles de dimensiones de archivo no vinculados a firmantes en un archivo específico.
	pageNo			string	Tipo de control. Indique eMeterai para representar el control de impuesto de sellos indonesio.
	posX			float	Número de página donde se encuentra el control. El control de impuesto de sellos indonesio solo admite especificar una única página; debe proporcionarse un número de página individual, sin admitir formatos de múltiples páginas continuas o discontinuas como 1-3 o 1,3.
	posY			float	Desplazamiento en el eje x, con el origen de coordenadas en la esquina inferior izquierda de la página. El rango de coordenadas es consistente con el de otros controles.
signerFields				array	Información de la lista de controles de firmantes en la plantilla
	signConfigs			array	Información del control de firma
		fieldId		string	ID del control (generado automáticamente por eleSignGlobalsistema al configurar la plantilla del contrato)
		fieldKey		string	Clave del control (definida por el usuario al configurar la plantilla del contrato)
		fieldType		string	Tipo de control: signature-Zona de firma stamp-Zona de sello approval-Control de aprobación
		required		boolean	Si es obligatorio, por defecto obligatorio true-Obligatorio false-No obligatorio
		sizeRule		string	Modo de visualización del tamaño de la zona de firma originalSize-Ajustar el sello según el tamaño real de la firma/sello targetSize-Ancho y alto personalizados para la zona de firma/sello
		height		int	Altura del control de firma
		width		int	Anchura del control de firma
		movable		boolean	Permitir mover la posición durante la firma false-No se permite al firmante ajustar la posición de su propio control de firma true-Se permite al firmante ajustar la posición de su propio control de firma
		allowedOptions		array	Opciones permitidas para que el firmante apruebe, aplicable cuando fieldType es approval. Por defecto: ["approve", "decline"] approve-Aceptar decline-Rechazar
		posX		float	Coordenada X de la posición del control
		posY		float	Posición del controlYCoordenada Y
		pageNo		string	Número de página donde se encuentra el control
	fillConfigs			array	Información del control de firma
		fieldId		string	ID del control (generado automáticamente por el sistema al configurar la plantilla del contrato)eSignGlobal
		fieldKey		string	Clave del control (definida por el usuario al configurar la plantilla del contrato)
		fieldName		string	Nombre del control
		required		boolean	Campo obligatorio true-Obligatorio false-No obligatorio
		fieldsType		string	Tipo de control: 1-Texto de una sola línea 15-Casilla de verificación
		textField		object	Propiedades del control de texto
			overflowType	int	Solo aplica a text 1-Reducción automática del tamaño de fuente 2-Limitar entrada
			minFontSize	float	Solo aplica a text, solo aplica cuando 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	Ancho del control
			fontSize	float	Solo aplica a text, tamaño de fuente 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	Solo aplica a text, color hexadecimal
			bold	boolean	Solo aplica a text, si la fuente está en negrita true-Negrita false-Sin negrita
			italic	boolean	Solo aplica a text, si la fuente está en cursiva true-Cursiva false-No cursiva
			underline	boolean	Solo afecta al texto, si se añade o no un subrayado a la fuente true-Añadir subrayado false-No añadir subrayado
			lineThrough	boolean	Solo afecta al texto, si se añade o no una tachadura true-Añadir tachadura false-No añadir tachadura
			horizontalAlignment	string	Solo afecta al texto, formato de centrado horizontal LEFT-Alinear a la izquierda CENTER-Centrar RIGHT-Alinear a la derecha
		tickBoxField		object	Propiedades de la casilla de verificación
			tickOptions	array	Solo afecta a Check 1-Marcado 2-Tachado
		posX		float	Coordenada X de la posición del control
		posY		float	Posición del controlYCoordenada Y
		pageNo		string	Número de página donde se encuentra el control
	signDateConfigs			array	Información sobre la fecha de firma
		fieldId		string	ID del control (generado automáticamente por el sistema al configurar la plantilla del contrato)eSignGlobal
		fieldKey		string	Clave del control (definida por el usuario al configurar la plantilla del contrato)
		movable		boolean	Permitir mover la posición durante la firma false- No permitir que el firmante ajuste la posición de su control de firma true- Permitir que el firmante ajuste la posición de su control de firma
		posX		float	Coordenada X de la posición del control
		posY		float	Posición del controlYCoordenada Y
		pageNo		string	Número de página donde se encuentra el control
		signDateFormat		string	Formato de la fecha de firma

Ejemplo de respuesta

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