Получить подробную информацию о шаблоне

GET /esignglobal/v1/templates/templateDetail

Описание интерфейса

Запрос информации об элементах управления в шаблоне.

По номеру шаблона договораtemplateIdдля получения информации об элементах управления для заполнения, установленных в шаблоне, в дальнейшем можно через интерфейсЗаполнить шаблон для создания файла для заполнения шаблона.

Параметры запроса

Название параметра	Тип	Обязательно ли	Описание
templateId	string	true	ID шаблона договора, можно найти в списке шаблонов eSignGlobal

Пример запроса

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

Параметры ответа

Название параметра				Тип	Описание
templateId				string	ID шаблона договора
templateName				string	Название шаблона договора
templateType				int	Тип шаблона договора: 0-PDF, 1-WORD
createTime				string	Время создания шаблона договора (в формате временной метки Unix, единица измерения: миллисекунды)
updateTime				string	Время обновления шаблона договора (в формате временной метки Unix, единица измерения: миллисекунды)
templateStatus				int	Статус шаблона договора: 0-не активирован, 1-активирован
fields				array	Информация о списке элементов управления в шаблоне
	fieldId			string	ID элемента управления (автоматически генерируется системой eSignGlobal при настройке шаблона договора)
	fieldKey			string	Ключ элемента управления (определяется пользователем при настройке шаблона договора)
	fieldName			string	Название элемента управления
	required			boolean	Обязательно ли поле: True - обязательно, false - не обязательно
	fieldType			string	1 - однострочный текст, 2 - число, 3 - дата, 8 - многострочный текст, 9 - множественный выбор, 10 - одиночный выбор, 11 - изображение, 14 - выпадающий список, 15 - флажок
	fieldPosition			object	Информация о местоположении элемента управления (возвращается только для PDF-шаблонов)
		posX		float	X-координата местоположения элемента управления
		posY		float	Y-координата местоположения элемента управления
		posNo		int	Страница, на которой находится элемент управления
		movable		boolean	Разрешить перемещение местоположения при подписании, по умолчанию false false - не разрешать подписывающему лицу регулировать положение своих элементов управления подписью true - разрешить подписывающему лицу регулировать положение своих элементов управления подписью
	fieldSpecialAttribute			object	Уникальные свойства элемента управления
		dateFormat		string	Формат даты (уникален для элемента управления датой)
		imageType		string	Тип изображения (уникален для элемента управления изображением)
		options		array	Опции (специфично для выпадающих списков, радиокнопок и флажков)
			optionContent	string	Содержимое опции
			optionOrder	int	Порядок опций
			selected	boolean	Выбрана ли опция по умолчанию
		numberFormat		string	Формат чисел (специфичен для числовых элементов управления), формат следующий: 0 - целое число, 0.0 - одна цифра после запятой, 0.00 - две цифры после запятой
		tableContent		array	Содержимое строк и столбцов таблицы (специфично для динамических элементов управления таблицей), формат: [row{"column1":"value1","column2":"value2"}] Дополнительные пояснения: row представляет строку, соответствующую динамической таблице, количество row зависит от шаблона Количество строк, добавленных в динамический элемент управления таблицей. column1 представляет значение ключа ячейки в текущей строке, value1 представляет значение ячейки в текущей строке. Если для ячейки не установлено фиксированное значение, то это пустая строка "", в противном случае это установленное фиксированное значение. Подробности см. в пояснениях к tableContent.
		fieldMaxLength		string	Максимальная длина для заполнения, единица измерения: китайские иероглифы 【Примечание】1 китайский иероглиф = 2 английских символа;
	fieldSize			object	Размер элемента управления
		fieldWidth		float	Ширина элемента управления (расстояние слева направо прямоугольника, в пикселях)
		fieldHeight		float	Высота элемента управления (расстояние сверху вниз прямоугольника, в пикселях)

Пример ответа

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