GET /esignglobal/v1/templates/templateDetail
คำอธิบายอินเทอร์เฟซ
สอบถามข้อมูลการควบคุมในเทมเพลต
ผ่านหมายเลขเทมเพลตสัญญาtemplateIdเพื่อรับข้อมูลการควบคุมการกรอกที่ตั้งค่าไว้ในเทมเพลต จากนั้นสามารถใช้ผ่านอินเทอร์เฟซ กรอกเทมเพลตเพื่อสร้างไฟล์ เพื่อเติมเทมเพลต
พารามิเตอร์คำขอ
ชื่อพารามิเตอร์ | ประเภท | จำเป็นต้องกรอกหรือไม่ | คำอธิบาย |
templateId | string | true | ID เทมเพลตสัญญา สามารถสอบถามได้ในรายการเทมเพลตของ eSignGlobal |
ตัวอย่างคำขอ
GET https:// … …/esignglobal/v1/templates/templateDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf
พารามิเตอร์การตอบสนอง
ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย |
templateId | string | 合同模板ID |
templateName | string | ชื่อเทมเพลตสัญญา |
templateType | int | ประเภทเทมเพลตสัญญา: 0-PDF, 1-WORD |
createTime | string | เวลาสร้างเทมเพลตสัญญา (รูปแบบ Unix timestamp หน่วย: มิลลิวินาที) |
updateTime | string | เวลาอัปเดตเทมเพลตสัญญา (รูปแบบ Unix timestamp หน่วย: มิลลิวินาที) |
templateStatus | int | สถานะเทมเพลตสัญญา: 0-ไม่ได้เปิดใช้งาน, 1-เปิดใช้งาน |
fields | array | ข้อมูลรายการตัวควบคุมในเทมเพลต |
| fieldId | string | 控件ID (สร้างโดยอัตโนมัติโดยระบบ eSignGlobal เมื่อตั้งค่าเทมเพลตสัญญา) |
| fieldKey | string | 控件Key (ผู้ใช้กำหนดเองเมื่อตั้งค่าเทมเพลตสัญญา) |
| fieldName | string | ชื่อตัวควบคุม |
| required | boolean | 控件是否必填： True-บังคับ, false-ไม่บังคับ |
| fieldType | string | 1-ข้อความบรรทัดเดียว, 2-ตัวเลข, 3-วันที่, 8-ข้อความหลายบรรทัด, 9-เลือกได้หลายข้อ, 10- เลือกได้ข้อเดียว, 11- รูปภาพ, 14-ดรอปดาวน์, 15-ช่องทำเครื่องหมาย |
| fieldPosition | object | ข้อมูลตำแหน่งของ控件 (ส่งคืนเฉพาะเทมเพลต PDF เท่านั้น) |
| | posX | float | พิกัด X แนวนอนของตำแหน่ง控件 |
| | posY | float | พิกัด Y แนวตั้งของตำแหน่ง控件 |
| | posNo | int | หมายเลขหน้าของตัวควบคุม |
| | movable | boolean | อนุญาตให้ย้ายตำแหน่งเมื่อลงนาม ค่าเริ่มต้นคือ false false-ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งของตัวควบคุมการลงนามของตนเอง true-อนุญาตให้ผู้ลงนามปรับตำแหน่งของตัวควบคุมการลงนามของตนเอง |
| fieldSpecialAttribute | object | คุณสมบัติเฉพาะของตัวควบคุม |
| | dateFormat | string | รูปแบบวันที่ (เฉพาะสำหรับตัวควบคุมวันที่) |
| | imageType | string | ประเภทรูปภาพ (เฉพาะสำหรับตัวควบคุมรูปภาพ) |
| | options | array | ตัวเลือก (เฉพาะสำหรับตัวควบคุมดรอปดาวน์, ตัวควบคุมตัวเลือกเดียว, ตัวควบคุมตัวเลือกหลายรายการ) |
| | | optionContent | string | เนื้อหาตัวเลือก |
| | | optionOrder | int | ลำดับตัวเลือก |
| | | selected | boolean | ตัวเลือกถูกเลือกเป็นค่าเริ่มต้นหรือไม่ |
| | numberFormat | string | รูปแบบตัวเลข (เฉพาะตัวควบคุมตัวเลข) รูปแบบมีดังนี้: 0-จำนวนเต็ม, 0.0-ทศนิยม 1 ตำแหน่ง, 0.00-ทศนิยม 2 ตำแหน่ง |
| | tableContent | array | เนื้อหาแถวและคอลัมน์ของตาราง (เฉพาะตัวควบคุมตารางแบบไดนามิก) รูปแบบ: [row{"column1":"value1","column2":"value2"}] คำอธิบายเพิ่มเติม: row หมายถึงแถวที่สอดคล้องกับตารางแบบไดนามิก จำนวน row ขึ้นอยู่กับเทมเพลต จำนวนแถวที่เพิ่มในตัวควบคุมตารางแบบไดนามิก column1 หมายถึงค่า Key ของเซลล์ในแถวปัจจุบัน value1 หมายถึงค่า Value ของเซลล์ในแถวปัจจุบัน หากเซลล์ไม่ได้ตั้งค่าคงที่ ค่าจะเป็น "" สตริงว่างเปล่า มิฉะนั้นจะเป็นค่าคงที่ที่ตั้งไว้ ดูคำอธิบาย tableContent สำหรับรายละเอียด |
| | fieldMaxLength | string | ขีดจำกัดความยาวที่สามารถเติมได้ หน่วย: อักขระจีน [หมายเหตุ] อักขระจีน 1 ตัว = อักขระอังกฤษ 2 ตัว |
| fieldSize | object | ขนาดของส่วนควบคุม |
| | fieldWidth | float | ความกว้างของส่วนควบคุม (ระยะทางซ้ายขวาของสี่เหลี่ยมผืนผ้า หน่วยเป็น px) |
| | fieldHeight | float | ความสูงของส่วนควบคุม (ระยะทางบนล่างของสี่เหลี่ยมผืนผ้า หน่วยเป็น px) |
ตัวอย่างการตอบสนอง
{
"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": "成功 "
}
