Skip to main content Link Menu Expand (external link) Document Search Copy Copied

템플릿 조회

개요

전자계약서비스 싸인오케이 메인 페이지에서 설정한 특정 템플릿의 상세 정보를 조회합니다.


URL

/api/v2/template/{id}

요청 데이터

항목타입위치설명
idStringquery템플릿 ID

응답 데이터

항목타입위치설명
resultObjectbody결과 데이터
    idStringbody템플릿 ID
    titleStringbody제목
    created_datetimeStringbody생성 일시
    creator_idStringbody생성자 아이디
    creator_nameStringbody생성자 이름
    attach_filesArraybody템플릿 첨부파일
        nameStringbody템플릿 첨부파일 명
    optionsObjectbody-
        meetBooleanbody대면서명 여부
        signer_orderBooleanbody순차서명 여부
    signerArraybody서명 대상자 배열
        indexIntegerbody대상자 순번
        idStringbody대상자 ID값
        typeStringbody대상자 구분 – SIGNATORY(서명자), REVIEWER(검토자)
        sign_methodStringbody서명방법 – SIMPLE(간편서명), CERTIFICATE(공동인증서서명)
        itemsArraybody입력항목 리스트
            typeStringbody입력항목 타입 - STAMP, TEXT, CHECKBOX, SELECTBOX
            KeyStringbodyAPI Key
            aliasStringbody항목명
            requiredBooleanbody필수여부
            pageIntegerbody입력항목 페이지
        attach_filesArraybody첨부파일 요청
            nameStringbody요청 첨부파일 이름
            descriptionStringbody요청 첨부파일 설명
            requiredBooleanbody필수 여부
codeStringbody성공, 실패 코드
messageStringbody성공, 실패 메시지

응답 데이터 예시

{
    "result": {
        "id": "c1947421c93a40faa86f82bed5795eb5",
        "title": "title",
        "create_id": "test@signgate.com",
        "creator_name": "creator_name",
        "create_datetime": "2023-06-05 09:56:49",
        "attach_files": [],
        "options": {
            "meet": true,
            "signer_order": false
        },
        "signer": [
            {
                "id": "cc1d326dcefc48dbbf6ba00bdfab6ac4",
                "index": 1,
                "type": "SIGNATORY",
                "sign_method": "SIMPLE",
                "items": [
                    {
                        "type": "CHECKBOX",
                        "alias": "체크박스",
                        "required": true,
                        "page": 1
                    },
                    {
                        "type": "STAMP",
                        "alias": "스탬프박스",
                        "key": "org_stamp",
                        "required": true,
                        "page": 1
                    },
                    {
                        "type": "TEXT",
                        "alias": "텍스트박스",
                        "required": false,
                        "page": 1
                    },
                    {
                        "type": "RADIOBOX",
                        "alias": "라디오박스",
                        "required": true,
                        "page": 1
                    }
                ],
                "attach_files": []
            }
        ]
    },
    "code": "200",
    "message": "success"
}

Back to top

COPYRIGHT (C) 2022 KICA INC. ALL RIGHTS RESERVED