Vorlagendetails abrufen

GET /esignglobal/v1/templates/templateDetail

Schnittstellenbeschreibung

Abfrage der Steuerelementinformationen in der Vorlage.

Über die Vertragsnummer der VorlagetemplateIdkönnen Sie die in der Vorlage eingestellten Ausfüllsteuerelementinformationen abrufen. Anschließend können Sie die Schnittstelle Vorlage zum Generieren von Dateien ausfüllen verwenden, um die Vorlage auszufüllen.

Anfrageparameter

Parametername	Typ	Ist erforderlich	Beschreibung
templateId	string	true	Vertragsvorlagen-ID, kann in der Vorlagenliste von eSignGlobal abgefragt werden

Beispielanfrage

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

Antwortparameter

Parametername				Typ	Beschreibung
templateId				string	Vertragsvorlagen-ID
templateName				string	Name der Vertragsvorlage
templateType				int	Vertragsvorlagentyp: 0-PDF, 1-WORD
createTime				string	Erstellungszeitpunkt der Vertragsvorlage (Unix-Zeitstempelformat, Einheit: Millisekunden)
updateTime				string	Aktualisierungszeitpunkt der Vertragsvorlage (Unix-Zeitstempelformat, Einheit: Millisekunden)
templateStatus				int	Vertragsvorlagenstatus: 0-Deaktiviert, 1-Aktiviert
fields				array	Liste der Steuerelemente in der Vorlage
	fieldId			string	Steuerelement-ID (wird beim Einrichten der Vertragsvorlage automatisch vom eSignGlobal-System generiert)
	fieldKey			string	Steuerelement-Key (wird beim Einrichten der Vertragsvorlage vom Benutzer definiert)
	fieldName			string	Name des Steuerelements
	required			boolean	Ist das Steuerelement erforderlich: True - erforderlich, false - nicht erforderlich
	fieldType			string	1 - einzeiliger Text, 2 - Zahl, 3 - Datum, 8 - mehrzeiliger Text, 9 - Mehrfachauswahl, 10 - Einfachauswahl, 11 - Bild, 14 - Dropdown-Feld, 15 - Kontrollkästchen
	fieldPosition			object	Informationen zur Steuerelementposition (wird nur von PDF-Vorlagen zurückgegeben)
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	Y-Koordinate der Steuerelementposition
		posNo		int	Seitenzahl, auf der sich das Steuerelement befindet
		movable		boolean	Bewegung der Position beim Signieren zulassen, Standardwert ist false false - Unterzeichner darf die Position seiner eigenen Signatur-Steuerelemente nicht anpassen true - Unterzeichner darf die Position seiner eigenen Signatur-Steuerelemente anpassen
	fieldSpecialAttribute			object	Steuerelementspezifische Attribute
		dateFormat		string	Datumsformat (speziell für Datumssteuerelemente)
		imageType		string	Bildtyp (speziell für Bildsteuerelemente)
		options		array	Optionen (speziell für Dropdown-Steuerelemente, Optionsfeld-Steuerelemente, Mehrfachauswahl-Steuerelemente)
			optionContent	string	Optionsinhalt
			optionOrder	int	Optionsreihenfolge
			selected	boolean	Ist die Option standardmäßig ausgewählt?
		numberFormat		string	Zahlenformat (speziell für Zahlen-Steuerelemente), Format wie folgt: 0 - ganze Zahl, 0.0 - eine Dezimalstelle, 0.00 - zwei Dezimalstellen
		tableContent		array	Tabellenzeilen- und Spalteninhalt (speziell für dynamische Tabellen-Steuerelemente), Format: [row{"column1":"value1","column2":"value2"}] Zusätzliche Hinweise: row steht für die entsprechende Zeile der dynamischen Tabelle, die Anzahl der Zeilen richtet sich nach der Vorlage Anzahl der hinzugefügten Zeilen im dynamischen Tabellen-Steuerelement. column1 steht für den Key-Wert der Zelle in der aktuellen Zeile, value1 steht für den Value-Wert der Zelle in der aktuellen Zeile. Wenn für die Zelle kein fester Wert festgelegt ist, ist es ein leerer String "", andernfalls der festgelegte Wert. Siehe Erläuterungen zu tableContent.
		fieldMaxLength		string	Maximale ausfüllbare Länge, Einheit: chinesische Zeichen 【Hinweis】1 chinesisches Zeichen = 2 englische Zeichen;
	fieldSize			object	Steuerungsgröße
		fieldWidth		float	Steuerungsbreite (horizontaler Abstand des Rechtecks, Einheit ist px)
		fieldHeight		float	Steuerungshöhe (vertikaler Abstand des Rechtecks, Einheit ist px)

Beispielantwort

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