Obter detalhes do modelo

GET /esignglobal/v1/templates/templateDetail

Descrição da Interface

Consulta as informações dos controlos no modelo.

Através do número do modelo de contratotemplateIdpara obter as informações dos controlos de preenchimento definidos no modelo, que podem ser preenchidos posteriormente através da interfacePreencher o modelo para gerar o ficheiro para preencher o modelo.

Parâmetros de Pedido

Nome do Parâmetro	Tipo	Obrigatório	Descrição
templateId	string	true	ID do modelo de contrato, pode ser consultado na lista de modelos do eSignGlobal

Exemplo de Pedido

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

Parâmetros de Resposta

Nome do Parâmetro				Tipo	Descrição
templateId				string	ID do Modelo de Contrato
templateName				string	Nome do Modelo de Contrato
templateType				int	Tipo de Modelo de Contrato: 0-PDF, 1-WORD
createTime				string	Data de Criação do Modelo de Contrato (Formato de Timestamp Unix, Unidade: Milissegundos)
updateTime				string	Data de Atualização do Modelo de Contrato (Formato de Timestamp Unix, Unidade: Milissegundos)
templateStatus				int	Estado do Modelo de Contrato: 0-Desativado, 1-Ativado
fields				array	Informações da Lista de Controlos no Modelo
	fieldId			string	ID do Controlo (Gerado automaticamente pelo sistema eSignGlobal ao definir o modelo de contrato)
	fieldKey			string	Chave do Controlo (Definida pelo utilizador ao definir o modelo de contrato)
	fieldName			string	Nome do Controlo
	required			boolean	Controlo obrigatório: True - Obrigatório, false - Não obrigatório
	fieldType			string	1 - Texto de linha única, 2 - Número, 3 - Data, 8 - Texto de várias linhas, 9 - Caixa de verificação, 10 - Botão de opção, 11 - Imagem, 14 - Caixa pendente, 15 - Caixa de seleção
	fieldPosition			object	Informações de localização do controlo (apenas devolvidas pelo modelo PDF)
		posX		float	Coordenada X horizontal da localização do controlo
		posY		float	Coordenada Y vertical da localização do controlo
		posNo		int	Página onde o controlo está localizado
		movable		boolean	Permitir mover a posição ao assinar, predefinição é false false - Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura true - Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura
	fieldSpecialAttribute			object	Propriedades específicas do controlo
		dateFormat		string	Formato da data (específico do controlo de data)
		imageType		string	Tipo de imagem (específico do controlo de imagem)
		options		array	Opções (específico para controlos de caixa pendente, controlos de rádio e controlos de seleção múltipla)
			optionContent	string	Conteúdo da opção
			optionOrder	int	Ordem das opções
			selected	boolean	Opção selecionada por defeito?
		numberFormat		string	Formato numérico (específico do controlo numérico), formato: 0 - inteiro, 0.0 - manter uma casa decimal, 0.00 - manter duas casas decimais
		tableContent		array	Conteúdo das linhas e colunas da tabela (específico do controlo de tabela dinâmica), formato: [row{"column1":"value1","column2":"value2"}] Observações: row representa a linha correspondente da tabela dinâmica, o número de rows depende do modelo O número de linhas adicionadas no controlo de tabela dinâmica. column1 representa o valor da chave da célula na linha atual, value1 representa o valor da célula na linha atual. Se a célula não tiver um valor fixo definido, será uma string vazia "", caso contrário, será o valor fixo definido. Ver explicação detalhada de tableContent.
		fieldMaxLength		string	Limite superior do comprimento preenchível, unidade: caracteres chineses [Nota] 1 caractere chinês = 2 caracteres ingleses;
	fieldSize			object	Dimensões do Controlo
		fieldWidth		float	Largura do controlo (distância horizontal do retângulo, em px)
		fieldHeight		float	Altura do controlo (distância vertical do retângulo, em px)

Exemplo de Resposta

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