문서 상세 조회

설명

문서의 상세 내역을 조회하기위한 API 입니다.

조회 API

문서의 상세 내역을 조회한다.

요청 URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/doc/{docId}

요청 헤더

헤더 명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며<br /API Gateway 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW 에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값 과 Secret Key 로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키(CompanyId)Developers 기본 설정 연동키
docId String 36 Y 연동키(DocId)조회 대상 문서 ID

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명

요청 예시

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/52e6e775-6993-424d-bc58-62e17268ed29/doc/25025

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/52e6e775-6993-424d-bc58-62e17268ed29/doc/25025
HOST: workplace.apigw.ntruss.com:443
x-ncp-apigw-timestamp:1521787414578
x-ncp-apigw-api-key:AKLJsfKIy12AJDW0Q2MxANdoiAZKxWwG3NOvT6aZ
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v1:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

응답 파라미터

파라미터 타입 크기 필수 여부 설명
doc Map Y 문서정보
drftUserStatCd > Map Y 작성자 상태 정보
code >>String 36 Y 상태 코드
name >> String 100 N 상태명(default)
i18nNames >> Map N 상태명 다국어
drftDeptCd > String 36 Y 작성자 부서 코드
aprvDocId > String 20 Y 결재 문서 ID
drftUserId > String 36 Y 작성자 ID
drftYmdhmsDt > String 100 Y 기안 일시
trgtUserNm > String 150 Y 신청자명
docTitle > String 1000 Y 문서 제목
trgtCompanyId > String 36 Y 신청자 회사 ID
drftCompanyNm > String 150 Y 작성자 회사명
shreOpninCnt > String 10 Y 공유 의견 개수
drftCompanyId > String 36 Y 작성자 회사 ID
trgtJobNm > String 150 N 신청자 직책명
drftJobNm > String 150 N 작성자 직책명
trgtDeptNm > String 150 N 신청자 부서명
companyNm > String 150 N 문서 회사명
delYmdhmsDt > String 100 N 숨긴 일시
dfmId > String 36 Y 서식 ID
trgtUserStat > Map 36 Y 신청자 상태 코드
code >> String 36 Y 상태 코드
name >> String 150 Y 상태 코드 명
i18nNames >> Map N 상태명 다국어
drftTzCd > String 100 N 문서 신청 ZoneId
drftPositNm > String 150 N 작성자 직급명
trgtPositCd > String 150 N 신청자 직급 코드
cmpltYmdhmsDt > String 100 N 완료 일시
shreTimeTpCd > Map 100 N 공유설정 시점
code >> String 36 Y 코드
name >> String 150 Y 코드 명
i18nNames >> Map N 다국어
drftDeptNm > String 150 N 작성자 부서명
drftUserNm > String 150 N 작성자명
trgtDeptCd > String 50 N 신청자 부서 코드
modifiableYn > String 1 N 문서 수정 가능 여부
docNo > String 36 Y 문서 번호
trgtUserId > String 36 Y 신청자 ID
dfmTpCd > String 36 N 공유 상세설정정보
dfmVersion > String 9 Y 서식 버전
delYn > String 1 Y 숨기기 여부
trgtCompanyNm > String 150 N 신청자 회사명
trgtJobCd > String 150 N 신청자 직책 코드
companyId > String 36 Y 회사 ID
delUserId > String 36 Y 문서 상태 코드
docStatCd > Map Y 문서 상태 코드
code >> String 36 Y 코드
name >> String 150 Y 코드 명
i18nNames >> Map N 다국어
proxyYn > String 1 Y 대리 신청 여부
commonDfmYn > String 1 Y 공통 서식 여부
drftJobCd > String 1 N 작성자 직책 코드
tenantId > String 36 Y 테넌트 ID
dfmNm > String 150 Y 서식명
trgtPositNm > String 150 N 신청자 직급명
category > Map 150 Y 카테고리
code >> String 36 Y 코드
name >> String 150 Y 코드 명
i18nNames >> Map N 다국어
drftPositCd > String 36 Y 작성자 직급 코드
aprvUseYn > String 1 Y 결재선 사용 여부
shre Map Y 공유정보
shreUsersList > List N 공유대상정보
shrePositNm >> String 150 N 공유 대상 직급명 (공유 대상이 사원일 경우)
revisionSeq >> String 10 N 이력 번호 (1 based)
aprvDocId >> String 20 N 결재 문서 ID
shreJobCd >> String 36 N 공유 대상 직책 코드 (공유 대상이 사원일 경우)
shreJobNm >> String 150 N 공유 대상 직책명 (공유 대상이 사원일 경우)
shreUserStatCd >> String 36 N 공유 대상자 상태 코드
shreObjectId >> String 36 N 공유 대상 ID
shrePositCd >> String 36 N 공유 대상 직급 코드 (공유 대상이 사원일 경우)
shreDeptCd >> String 36 N 공유 대상 부서 코드 (공유 대상이 사원일 경우)
shreObjectTpCd >> Map N 공유 대상 구분 코드
code >>> String 36 N 코드
name >>> String 150 N 코드 명
i18nNames >>> Map N 다국어
shreObjectNm >> String 150 N 공유 대상명
shreDeptNm >> String 150 N 공유 대상 부서명 (공유 대상이 사원일 경우)
shreTpCd > Nap 36 Y 공유시점
code >> String 36 Y 코드
name >> String 150 Y 코드 명
i18nNames >> Map Y 다국어
aprvLineList List N 결재선
aprvDeptNm > String 150 N 결재자 부서명
aprvUserStatCd > Map N 결재자 상태
code >> String 36 N 코드
name >> String 150 N 코드 명
i18nNames >> Map N 다국어
defaultYn > String 1 N 기본 결재선 여부
delegUserNm > String 150 N 위임 처리한 사원명 (자동 위임된 경우 제외)
aprvUserNm > String 150 N 결재자명
aprvPositNm > String 150 N 결재자 직급명
aprvDocId > String 20 N 결재 문서 ID
aprvObjectTpNm > String 150 N 결재 대상구분명
aprvCompanyId > String 36 N 결재자 회사 ID
aprvJobCd > String 36 N 결재자 직책 코드
aprvObjectId > String 36 N 결재 대상
aprvUserId > String 36 N 결재자 ID
aprvPositCd > String 36 N 결재자 직급 코드
aprvCompanyNm > String 150 N 결재자 회사명
revisionSeq > String 10 N 이력 번호 (1 based)
aprvObjectTpCd > Map N 결재 대상구분 코드
code >> String 36 N 코드
name >> String 150 N 코드 명
i18nNames >> Map N 다국어
delegUserId > String 36 N 위임 처리한 사원 ID (자동 위임된 경우 제외)
rptToYn > String 1 N Reports To 여부
aprvTpCd > Map N 결재 유형 코드
code >> String 36 N 코드
name >> String 150 N 코드 명
i18nNames >> Map N 다국어
aprvDeptCd > String 36 N 결재자 부서 코드
aprvJobNm > String 150 N 결재자 직책명
aprvStatCd > Map N 결재 상태 코드
code >> String 36 N 코드
name >> String 150 N 코드 명
i18nNames >> Map N 다국어
aprvOrd > String 9 N 결재 순서 (1 based)
rptUserId > String 36 N Reportee ID
aprvOpnin > String 1000 N 처리 의견
aprvYmdhmsDt > String 100 N 처리 일시
info Map Y 결재문서내역
tenantId > String 36 Y 테넌트 ID
companyId > String 36 Y 회사 ID
aprvId > String 36 Y 문서 ID
empId > String 36 Y 신청자 ID
aprvDt > String 10 Y 신청 대상일자
docNo > String 100 Y 문서번호
title > String 1000 Y 문서제목
content > String 4000 N 내용
docStat > Map Y 진행상태
code >> String 36 N 코드
name >> String 150 N 코드 명
i18nNames >> Map N 다국어
detailList > List Y 근무계획신청시간 리스트
startDt >> String 100 Y 신청시작시각
endDt >> String 100 Y 신청종료시각

응답 예시

{
"doc": {
    "drftUserStat": {
      "code": "IN",
      "name": "재직",
      "i18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    "drftDeptCd": "abc002",
    "aprvDocId": 25675,
    "drftUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "drftYmdhmsDt": "2020-03-19T10:07:26+09:00[Asia/Seoul]",
    "trgtUserNm": "홍길동",
    "docTitle": "부재일정 공유합니다.",
    "trgtCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "drftCompanyNm": "ABC Corporation",
    "shreOpninCnt": 0,
    "drftCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "trgtJobNm": "",
    "drftJobNm": "",
    "trgtDeptNm": "기획팀",
    "companyNm": null,
    "delYmdhmsDt": null,
    "dfmId": "D000000001",
    "trgtUserStat": {
      "code": "IN",
      "name": "재직",
      "i18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    "drftTzCd": "Pacific/Midway",
    "drftPositNm": "",
    "trgtPositCd": null,
    "cmpltYmdhmsDt": null,
    "shreTimeTpCd": {
      "code": "anyTime",
      "name": "문서 작성부터 계속 공유",
      "i18nNames": {
        "zh_TW": "從編寫文件起持續分享",
        "ko_KR": "문서 작성부터 계속 공유",
        "en_US": "Share from document creation",
        "zh_CN": "从编写文件起持续共享",
        "ja_JP": "文書作成から継続して共有"
      }
    },
    "drftDeptNm": "기획팀",
    "drftUserNm": "홍길동",
    "trgtDeptCd": "abc002",
    "modifiableYn": "Y",
    "docNo": "2020-TIM01-000060",
    "trgtUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "dfmTpCd": null,
    "dfmVersion": null,
    "delYn": "N",
    "trgtCompanyNm": "ABC Corporation",
    "trgtJobCd": null,
    "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "delUserId": null,
    "docStatCd": {
      "code": "ing",
      "name": "진행중",
      "i18nNames": {
        "zh_TW": "進行",
        "ko_KR": "진행중",
        "en_US": "Ongoing",
        "zh_CN": "进行",
        "ja_JP": "実行"
      }
    },
    "proxyYn": "N",
    "commonDfmYn": "Y",
    "drftJobCd": null,
    "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "dfmNm": "부재 일정(ko)",
    "trgtPositNm": "",
    "category": {
      "code": "1973",
      "name": "인사",
      "i18nNames": {
        "ko_KR": "인사",
        "en_US": "HR",
        "ja_JP": "인사",
        "zh_CN": "인사",
        "zh_TW": "인사"
      }
    },
    "drftPositCd": null,
    "aprvUseYn": "Y"
  },


  "shre": {
    "shreUsersList": [
      {
        "shrePositNm": "",
        "revisionSeq": 1,
        "aprvDocId": 25675,
        "shreJobCd": null,
        "shreJobNm": "",
        "shreUserStatCd": "IN",
        "shreObjectId": "f649075b-f196-4599-a71e-3b3fde723b6f",
        "shrePositCd": null,
        "shreDeptCd": "abc002",
        "shreObjectTpCd": {
          "code": "user",
          "name": "사용자",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "19년입사",
        "shreDeptNm": "기획팀"
      },
      {
        "shrePositNm": "",
        "revisionSeq": 1,
        "aprvDocId": 25675,
        "shreJobCd": null,
        "shreJobNm": "",
        "shreUserStatCd": "IN",
        "shreObjectId": "59a674bb-24f5-471f-a066-1d7ed8af8e04",
        "shrePositCd": null,
        "shreDeptCd": "abc002",
        "shreObjectTpCd": {
          "code": "user",
          "name": "사용자",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "2016년입사",
        "shreDeptNm": "기획팀"
      }
    ],
    "shreTpCd": {
      "code": "partShre",
      "name": "일부 공유",
      "i18nNames": {
        "zh_TW": "部分分享",
        "ko_KR": "일부 공유",
        "en_US": "Share to Selected",
        "zh_CN": "部分共享",
        "ja_JP": "一部共有"
      }
    }
  },
   "aprvLineList": [
    {
      "aprvDeptNm": "ABC Corp",
      "aprvUserStatCd": {
        "code": "IN",
        "name": "재직",
        "i18nNames": {
          "zh_TW": "在職",
          "ko_KR": "재직",
          "en_US": "Work",
          "zh_CN": "在职",
          "ja_JP": "在職"
        }
      },
      "defaultYn": "N",
      "delegUserNm": "",
      "aprvUserNm": "박명식",
      "aprvPositNm": "",
      "aprvPositCd": null,
      "aprvDocId": 25675,
      "aprvObjectTpNm": null,
      "aprvCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "aprvJobCd": null,
      "aprvObjectId": null,
      "aprvUserId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "aprvCompanyNm": "ABC Corporation",
      "revisionSeq": 3,
      "aprvObjectTpCd": {
        "code": "user",
        "name": "사용자",
        "i18nNames": {
          "zh_TW": "使用者",
          "ko_KR": "사용자",
          "en_US": "User",
          "zh_CN": "用户",
          "ja_JP": "使用者"
        }
      },
      "delegUserId": null,
      "rptToYn": "N",
      "aprvTpCd": {
        "code": "refer",
        "name": "참조",
        "i18nNames": {
          "zh_TW": "參照",
          "ko_KR": "참조",
          "en_US": "Reference",
          "zh_CN": "参照",
          "ja_JP": "参照"
        }
      },
      "aprvDeptCd": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "aprvJobNm": "",
      "aprvStatCd": {
        "code": "cmplt",
        "name": "동의",
        "i18nNames": {
          "zh_TW": "核准",
          "ko_KR": "동의",
          "en_US": "Approve",
          "zh_CN": "审批",
          "ja_JP": "承認"
        }
      },
      "aprvOrd": 1,
      "rptUserId": null,
      "aprvOpnin": null,
      "aprvYmdhmsDt": "2020-03-19T10:07:33+09:00[Asia/Seoul]"
    }
  ],
  "info": {
    "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "aprvId": "23270",
    "empId": "96b02530-82de-41c8-8223-3055c74e705e",
    "aprvDt": "2019-11-14",
    "docNo": "2019-TCP01-000183",
    "title": "근무 계획 신청 - 2019.11.14",
    "content": "ddddd",
    "msg": null,
    "docStat": {
      "code": "cmplt",
      "name": "동의",
      "i18nNames": {
        "zh_TW": "核准",
        "ko_KR": "동의",
        "en_US": "Approve",
        "zh_CN": "审批",
        "ja_JP": "承認"
      }
    },
    "detailList": [
      {
        "startDt": "2019-11-14T10:00-11:00[Pacific/Midway]",
        "endDt": "2019-11-14T12:00-11:00[Pacific/Midway]"
      }
    ]
  }
}

응답

HTTP 상태 코드로 리턴되고, Body정보로 전달한다.

HTTP 상태 코드 응답 메세지 설명
200 OK 일반적인 요청 성공
400 Bad Request 일반적인 요청실패에 사용( 대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
401 Unauthorized 인증이 필요
403 Forbidden 서버요청거부
404 Not Found 요청한 페이지 찾을 수 없음
500 Internal Server Error 일반적인 서버 에러에 대한 응답코드입니다. 4XX대의 에러코드가 클라이언트 측 에러를 나타내기 위해 사용된다면,
5XX대의 에러코드는 서버 측 에러를 나타내기 위해 사용