Dapatkan detail kontrol templat penanda tangan

GET/esignglobal/v1/templates/signerFieldsDetail

Deskripsi Antarmuka

Menanyakan informasi kontrol penanda tangan dalam templat.

Melalui nomor templat kontraktemplateIduntuk mendapatkan informasi kontrol penanda tangan yang ditetapkan dalam templat, yang selanjutnya dapat digunakan melaluiMulai amplop dengan cepatantarmuka untuk memulai amplop.

Parameter Permintaan

Nama Parameter	Jenis	Wajib Diisi	Keterangan
templateId	string	true	ID templat kontrak, dapat ditanyakan di manajemen templat SaaS

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Tipe	Deskripsi
templateId				string	ID Template Kontrak
templateName				string	Nama Template Kontrak
signerFields				array	Informasi daftar kontrol penanda tangan di template
	signConfigs			array	Informasi Kontrol Penandatanganan
		fieldId		string	ID Kontrol (dibuat secara otomatis oleheSignGlobalsistem saat mengatur template kontrak)
		fieldKey		string	Kunci Kontrol (ditetapkan oleh pengguna saat mengatur templat kontrak)
		fieldType		string	Jenis Kontrol: signature-Area Tanda Tangan stamp-Area Stempel approval-Kontrol Persetujuan
		sizeRule		string	Cara Menampilkan Ukuran Area Penandatanganan originalSize-Letakkan stempel sesuai dengan ukuran sebenarnya tanda tangan/stempel targetSize-Kustomisasi lebar dan tinggi area tanda tangan/stempel
		height		int	Tinggi kontrol tanda tangan
		width		int	Lebar kontrol tanda tangan
		movable		boolean	Izinkan memindahkan posisi saat menandatangani false-Tidak mengizinkan penandatangan untuk menyesuaikan posisi kontrol tanda tangan mereka sendiri true-Mengizinkan penandatangan untuk menyesuaikan posisi kontrol tanda tangan mereka sendiri
		allowedOptions		array	Opsi yang diizinkan untuk disetujui oleh penandatangan, berlaku untuk fieldType sebagai persetujuan. Defaultnya adalah ["approve", "decline"] approve-Setuju decline-Tolak
		posX		float	Koordinat X posisi kontrol
		posY		float	Posisi KontrolYKoordinat Y
		pageNo		string	Nomor halaman tempat kontrol berada
	fillConfigs			array	Informasi Kontrol Penandatanganan
		fieldId		string	ID Kontrol (dibuat secara otomatis oleheSignGlobalsistem saat mengatur templat kontrak)
		fieldKey		string	Kunci Kontrol (ditentukan oleh pengguna saat mengatur templat kontrak)
		fieldName		string	Nama Kontrol
		required		boolean	Apakah Wajib Diisi true-Wajib diisi false-Tidak wajib diisi
		fieldsType		string	Jenis Kontrol: 1-Teks Satu Baris 15- Kotak centang
		textField		object	Properti Kontrol Teks
			overflowType	int	Hanya berlaku untuk teks 1- Otomatis memperkecil ukuran font 2- Batasi input
			minFontSize	float	Hanya berlaku untuk teks, hanya berlaku untuk overflowType=1. 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			width	float	Lebar Kontrol
			fontSize	float	Hanya berlaku untuk teks, ukuran font 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			textColor	string	Hanya berlaku untuk teks, warna heksadesimal
			bold	boolean	Hanya berlaku untuk teks, apakah font dicetak tebal true-Tebal false-Tidak tebal
			italic	boolean	Hanya berlaku untuk teks, apakah miring true-Miring false-Tidak miring
			underline	boolean	Hanya berlaku untuk teks, apakah font diberi garis bawah true-Tambahkan garis bawah false-Jangan tambahkan garis bawah
			lineThrough	boolean	Hanya berlaku untuk teks, apakah akan menambahkan garis coret true-Tambahkan garis coret false-Jangan tambahkan garis coret
			horizontalAlignment	string	Hanya berlaku untuk teks, format rata tengah horizontal LEFT-Rata kiri CENTER-Tengah RIGHT-Rata kanan
		tickBoxField		object	Atribut kotak centang
			tickOptions	array	Hanya berlaku untuk Check 1-Centang 2-Silang
		posX		float	Koordinat X horizontal posisi kontrol
		posY		float	Posisi kontrolYKoordinat vertikal
		pageNo		string	Nomor halaman tempat kontrol berada
	signDateConfigs			array	Informasi tanggal penandatanganan
		fieldId		string	ID Kontrol (dibuat secara otomatis oleheSignGlobalsistem saat mengatur templat kontrak)
		fieldKey		string	Kunci Kontrol (didefinisikan oleh pengguna saat mengatur templat kontrak)
		movable		boolean	Izinkan memindahkan posisi saat menandatangani false-Tidak mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri true-Mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri
		posX		float	Koordinat X horizontal posisi kontrol
		posY		float	Posisi kontrolYKoordinat vertikal
		pageNo		string	Nomor halaman tempat kontrol berada
		signDateFormat		string	Format tanggal penandatanganan

Contoh respons

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}