문서 상세 조회

문서의 상세 정보를 조회합니다.

문서 Id를 이용해서 문서의 상세 정보를 조회

GET rest/api/documents/{id}

Query Parameters

Name	Type	Description
id	String	문서의 id

Headers

Name	Type	Description
apikey*	String	발급된 api key

Response Example

200: OK 성공 또는 핸들링된 오류

{
  "contractId": 1,
  "originalTemplateId": 1,
  "name": "표준계약서 샘플",
  "creator": "김함께",
  "modifier": "박수정", 
  "createDate": "2024-01-01T00:00:00",
  "modifiedDate": "2024-01-02T00:00:00",
  "expiredDate": "2024-01-15T00:00:00",
  "message": "남길말 샘플입니다.",
  "docSecurity": false,
  "userSecurity": false,
  "groupNameSend": false,
  "status": "Waiting",
  "tagData": "#태그샘플001#태그데이터002",
  "hideConsenseMessage": false,
  "contractors": [
    {
      "seq": 1,
      "name": "김서명",
      "contact": "[e-mail]",
      "phone": null,
      "sharedKey": "jyFXXXXXXXXXXXXXXXXXX",
      "language": "kor",
      "status": "Signed",
      "companyName": null,
      "companyRegNo": null,
      "participantType": "Sign",
      "additionalData": null,
      "attachmentFiles": [
        {
          "id": 10,
          "required": false,
          "requestName": "첨부파일001",
          "extension": "PNG",
          "exist": true
        }
      ],
      "content": {
        "page_1": {
          "text_1_이름": "김서명",
          "sign_2_서명": "+++HIDDEN_FIELD+++"
        }
      }
    },
    {
      "seq": 2,
      "name": "정싸인",
      "contact": "[e-mail]",
      "phone": "",
      "sharedKey": "893XXXXXXXXXXXXXXXXXX",
      "language": "kor",
      "status": "Waiting",
      "companyName": "",
      "companyRegNo": "",
      "participantType": "Sign",
      "additionalData": null,
      "attachmentFiles": [
        {
          "id": 11,
          "required": true,
          "requestName": "요청 파일",
          "extension": null,
          "exist": false
        }
      ],
      "content": {
        "page_1": {
          "sign_1_서명": ""
        }
      }
    }
  ],
  "referrers": [
    {
      "name": "참조자",
      "contact": "[e-mail]",
      "language": "kor"
    },
    {
      "name": "참조인",
      "contact": "01000000000",
      "language": "en"
    }
  ],
  "hideButtonAtComplete": false,
  "additionalData": "",
  "postProcessId": null,
  "signpadOption": "Default",
  "mobileCertOption": "Default",
  "participantPassword": false,
  "attachSecurity": false,
  "companyCert": false,
  "noOrder": false,
  "mobileCert": false,
  "content": {
    "page_1": {
      "text_1_내용": "샘플 데이터",
      "image_2_이미지":"+++HIDDEN_FIELD+++"
    }
  }
}

400: Bad Request 핸들링 하지 못한 오류에 대한 처리

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/documents"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

{
    "message": "Unauthorized"
}