Obtener detalles de la plantilla

GET /esignglobal/v1/templates/templateDetail

Descripción de la interfaz

Consulta la información de los controles en la plantilla.

A través del número de plantilla de contratotemplateIdpara obtener la información de los controles de llenado establecidos en la plantilla, que luego se puede usar a través de la interfazLlenar la plantilla para generar el archivo para completar la plantilla.

Parámetros de solicitud

Nombre del parámetro	Tipo	¿Es obligatorio?	Descripción
templateId	string	true	ID de la plantilla de contrato, se puede consultar en la lista de plantillas de eSignGlobal

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro				Tipo	Descripción
templateId				string	ID de plantilla de contrato
templateName				string	Nombre de la plantilla de contrato
templateType				int	Tipo de plantilla de contrato: 0-PDF, 1-WORD
createTime				string	Fecha de creación de la plantilla de contrato (formato de marca de tiempo Unix, unidad: milisegundos)
updateTime				string	Fecha de actualización de la plantilla de contrato (formato de marca de tiempo Unix, unidad: milisegundos)
templateStatus				int	Estado de la plantilla de contrato: 0-Deshabilitado, 1-Habilitado
fields				array	Información de la lista de controles en la plantilla
	fieldId			string	ID del control (generado automáticamente por el sistema eSignGlobal al configurar la plantilla de contrato)
	fieldKey			string	Clave del control (definida por el usuario al configurar la plantilla de contrato)
	fieldName			string	Nombre del control
	required			boolean	¿El control es obligatorio? True-Obligatorio, false-No obligatorio
	fieldType			string	1-Texto de una línea, 2-Número, 3-Fecha, 8-Texto de varias líneas, 9-Casilla de verificación, 10- Opción única, 11- Imagen, 14-Menú desplegable, 15-Casilla de verificación
	fieldPosition			object	Información de la posición del control (solo se devuelve en la plantilla PDF)
		posX		float	Coordenada X horizontal de la posición del control
		posY		float	Coordenada Y vertical de la posición del control
		posNo		int	Número de página donde se encuentra el control
		movable		boolean	Permitir mover la ubicación al firmar, el valor predeterminado es false false - No permitir que el firmante ajuste la ubicación de sus propios controles de firma true - Permitir que el firmante ajuste la ubicación de sus propios controles de firma
	fieldSpecialAttribute			object	Propiedades únicas del control
		dateFormat		string	Formato de fecha (único para controles de fecha)
		imageType		string	Tipo de imagen (único para controles de imagen)
		options		array	Opciones (característico de los controles de lista desplegable, controles de radio y controles de selección múltiple)
			optionContent	string	Contenido de la opción
			optionOrder	int	Orden de las opciones
			selected	boolean	¿La opción está seleccionada por defecto?
		numberFormat		string	Formato de número (específico del control de número), el formato es el siguiente: 0-entero, 0.0-conserva un decimal, 0.00-conserva dos decimales
		tableContent		array	Contenido de filas y columnas de la tabla (específico del control de tabla dinámica), formato: [row{"column1":"value1","column2":"value2"}] Notas adicionales: row representa la fila correspondiente a la tabla dinámica, el número de filas depende de la plantilla El número de filas añadidas en el control de tabla dinámica. column1 representa el valor de la clave de la celda en la fila actual, value1 representa el valor de la celda en la fila actual. Si la celda no tiene un valor fijo establecido, es una cadena vacía "", de lo contrario, es el valor fijo establecido. Ver la explicación de tableContent para más detalles.
		fieldMaxLength		string	Límite superior de longitud rellenable, unidad: caracteres chinos [Nota] 1 carácter chino = 2 caracteres ingleses;
	fieldSize			object	Tamaño del control
		fieldWidth		float	Ancho del control (la distancia horizontal del rectángulo, en px)
		fieldHeight		float	Altura del control (la distancia vertical del rectángulo, en px)

Ejemplo de respuesta

{
    "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": "成功 "
}