Dapatkan Detail Templat

GET /esignglobal/v1/templates/templateDetail

Deskripsi Antarmuka

Mengambil informasi kontrol dalam templat.

Melalui nomor templat kontraktemplateIduntuk mendapatkan informasi kontrol pengisian yang ditetapkan dalam templat, yang selanjutnya dapat diisi melalui antarmukaIsi templat untuk menghasilkan file untuk mengisi templat.

Parameter Permintaan

Nama Parameter	Jenis	Wajib Diisi	Keterangan
templateId	string	true	ID templat kontrak, dapat dicari di daftar templat eSignGlobal

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Tipe	Deskripsi
templateId				string	ID Templat Kontrak
templateName				string	Nama Templat Kontrak
templateType				int	Tipe Templat Kontrak: 0-PDF, 1-WORD
createTime				string	Waktu pembuatan templat kontrak (format stempel waktu Unix, satuan: milidetik)
updateTime				string	Waktu pembaruan templat kontrak (format stempel waktu Unix, satuan: milidetik)
templateStatus				int	Status templat kontrak: 0-Tidak diaktifkan, 1-Diaktifkan
fields				array	Informasi daftar kontrol dalam templat
	fieldId			string	ID Kontrol (dibuat secara otomatis oleh sistem eSignGlobal saat mengatur templat kontrak)
	fieldKey			string	Kunci Kontrol (ditentukan pengguna saat mengatur templat kontrak)
	fieldName			string	Nama Kontrol
	required			boolean	Apakah kontrol wajib diisi: True-Wajib diisi, false-Tidak wajib diisi
	fieldType			string	1-Teks satu baris, 2-Angka, 3-Tanggal, 8-Teks multi-baris, 9-Kotak centang, 10- Pilihan tunggal, 11- Gambar, 14-Kotak dropdown, 15-Kotak centang
	fieldPosition			object	Informasi posisi kontrol (hanya dikembalikan oleh templat PDF)
		posX		float	Koordinat X horizontal posisi kontrol
		posY		float	Koordinat Y vertikal posisi kontrol
		posNo		int	Nomor halaman tempat kontrol berada
		movable		boolean	Izinkan memindahkan posisi saat menandatangani, defaultnya false false-Tidak mengizinkan penandatangan untuk menyesuaikan posisi kontrol tanda tangan mereka sendiri true-Mengizinkan penandatangan untuk menyesuaikan posisi kontrol tanda tangan mereka sendiri
	fieldSpecialAttribute			object	Atribut unik kontrol
		dateFormat		string	Format tanggal (khusus untuk kontrol tanggal)
		imageType		string	Tipe gambar (khusus untuk kontrol gambar)
		options		array	Opsi (khusus untuk kontrol kotak drop-down, kontrol radio, dan kontrol kotak centang)
			optionContent	string	Isi opsi
			optionOrder	int	Urutan opsi
			selected	boolean	Apakah opsi dipilih secara default
		numberFormat		string	Format angka (khusus untuk kontrol angka), formatnya adalah sebagai berikut: 0-bilangan bulat, 0.0-mempertahankan satu desimal, 0.00-mempertahankan dua desimal
		tableContent		array	Isi baris dan kolom tabel (khusus untuk kontrol tabel dinamis), format: [row{"column1":"value1","column2":"value2"}] Catatan tambahan: row menunjukkan baris yang sesuai dengan tabel dinamis, jumlah row tergantung pada templat Jumlah baris yang ditambahkan dalam kontrol tabel dinamis. column1 menunjukkan nilai Key dari sel di baris saat ini, value1 menunjukkan nilai Value dari sel di baris saat ini. Jika sel tidak memiliki nilai tetap, maka nilainya adalah string kosong "", jika tidak, nilainya adalah nilai tetap yang ditetapkan. Lihat penjelasan tableContent untuk detailnya.
		fieldMaxLength		string	Batas atas panjang yang dapat diisi, satuan: karakter Mandarin [Catatan] 1 karakter Mandarin = 2 karakter Inggris;
	fieldSize			object	Ukuran Kontrol
		fieldWidth		float	Lebar kontrol (jarak kiri dan kanan persegi panjang, dalam px)
		fieldHeight		float	Tinggi kontrol (jarak atas dan bawah persegi panjang, dalam px)

Contoh Respons

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