Dapatkan detail kontrol template penandatangan

GET/esignglobal/v1/templates/signerFieldsDetail

Deskripsi Antarmuka

Memeriksa informasi kontrol penandatangan dalam templat.

Melalui nomor templat kontraktemplateIduntuk mendapatkan informasi kontrol penandatangan yang diatur dalam templat, selanjutnya dapat melaluiuntuk memulai amplop secara cepatantarmuka untuk memulai amplop.

Parameter Permintaan

Nama Parameter	Tipe	Wajib diisi	Keterangan
templateId	string	true	ID Templat Kontrak, dapat ditemukan di manajemen templat SaaS

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Tipe	Keterangan
templateId				string	ID Templat Kontrak
templateName				string	Nama Templat Kontrak
documentFields				array	Daftar Kontrol Berkas
	fieldType			string	Daftar kontrol dimensi berkas. Digunakan untuk menambahkan kontrol dimensi berkas yang tidak terikat pada penandatangan di berkas tertentu.
	pageNo			string	Tipe kontrol. Gunakan eMeterai untuk menunjukkan kontrol cukai meterai Indonesia.
	posX			float	Nomor halaman tempat kontrol berada. Kontrol cukai meterai Indonesia hanya mendukung satu halaman tunggal; masukkan nomor halaman tunggal saja, tidak mendukung format beberapa halaman berurutan atau tidak berurutan seperti 1-3 atau 1,3.
	posY			float	Offset sumbu x, dengan titik asal koordinat di sudut kiri bawah halaman. Rentang koordinat sama dengan rentang koordinat kontrol lainnya.
signerFields				array	Informasi daftar kontrol penandatangan dalam templat
	signConfigs			array	Informasi kontrol penandatangan
		fieldId		string	ID kontrol (dibuat secara otomatis oleheSignGlobalsistem saat menetapkan templat kontrak)
		fieldKey		string	Key kontrol (didefinisikan sendiri oleh pengguna saat menetapkan templat kontrak)
		fieldType		string	Tipe kontrol: signature-Area tanda tangan stamp-Area stempel approval-Kontrol persetujuan
		required		boolean	Apakah wajib diisi, default wajib true-Wajib diisi false-Tidak wajib diisi
		sizeRule		string	Tampilan ukuran area penandatanganan originalSize-Penempatan sesuai ukuran asli tanda tangan/stempel targetSize-Lebar dan tinggi area tanda tangan/stempel kustom
		height		int	Tinggi kontrol penandatanganan
		width		int	Lebar kontrol penandatanganan
		movable		boolean	Izinkan pengesahan untuk memindahkan posisi false-Pengsign tidak diizinkan mengubah posisi kontrol penandatanganan sendiri true-Pengsign diizinkan mengubah posisi kontrol penandatanganan sendiri
		allowedOptions		array	Opsi yang memungkinkan pengesah melakukan persetujuan, berlaku ketika fieldType adalah approval. 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 tanda tangan
		fieldId		string	ID kontrol (dibuat secara otomatis oleh sistem saat mengatur templat kontrak)eSignGlobal
		fieldKey		string	Key kontrol (didefinisikan secara kustom 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	Atribut kontrol teks
			overflowType	int	Hanya berlaku untuk text 1-Perkecil ukuran font secara otomatis 2-Batasi input
			minFontSize	float	Hanya berlaku untuk text, hanya berlaku saat 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 text, 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 text, warna heksadesimal
			bold	boolean	Hanya berlaku untuk text, apakah font tebal true-Tebal false-Tidak tebal
			italic	boolean	Hanya berlaku untuk text, apakah miring true-Miring false-Non-italic
			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 diberi coretan true-Tambahkan coretan false-Jangan tambahkan coretan
			horizontalAlignment	string	Hanya berlaku untuk teks, format rata tengah horizontal LEFT-Rata kiri CENTER-Rata tengah RIGHT-Rata kanan
		tickBoxField		object	Properti kotak centang
			tickOptions	array	Hanya berlaku untuk Check 1-Centang 2-Silang
		posX		float	Koordinat X posisi kontrol
		posY		float	Posisi kontrolYKoordinat Y
		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	Key kontrol (disesuaikan oleh pengguna saat mengatur templat kontrak)
		movable		boolean	Izinkan pengubahan posisi saat penandatanganan false- Penandatangan tidak diizinkan menyesuaikan posisi kontrol penandatanganan mereka sendiri true- Penandatangan diizinkan menyesuaikan posisi kontrol penandatanganan mereka sendiri
		posX		float	Koordinat X posisi kontrol
		posY		float	Posisi kontrolYKoordinat Y
		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"
}