템플릿 상세 정보 가져오기

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 타임스탬프 형식, 단위: 밀리초)
updateTime				string	계약 템플릿 업데이트 시간(Unix 타임스탬프 형식, 단위: 밀리초)
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-소수점 첫째 자리 유지, 0.00-소수점 둘째 자리 유지
		tableContent		array	표 행/열 내용(동적 표 컨트롤에만 해당), 형식: [row{"column1":"value1","column2":"value2"}] 추가 설명: row는 동적 표에 해당하는 행을 나타내고, row의 개수는 템플릿에 따릅니다. 동적 표 컨트롤에 추가된 행 수입니다. column1은 현재 행에서 셀의 키 값을 나타내고, value1은 현재 행에서 셀의 값을 나타냅니다. 셀에 고정 값이 설정되지 않은 경우 "" 빈 문자열이고, 그렇지 않으면 설정된 고정 값입니다. 자세한 내용은 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": "成功 "
}