관리자권한 문서리스트 조회 v1

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

관리자 권한으로 조회 가능한 결재문서를 조회하기 위한 API입니다.

조회 API

관리자 권한으로 조회 가능한 결재 문서를 조회한다.

요청 URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/{companyId}/mngdocs

요청 헤더

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

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키

요청 파라미터

파라미터	타입	크기	필수 여부	설명
categoryId	String	20	N	카테고리 ID
dfmId	String	20	N	서식 ID
dfmTpCd	String	20	N	서식 구분 코드
docStatCd	String	50	N	문서 상태 코드 문서 상태 코드 링크
docNo	String	100	N	문서 번호
docTitle	String	1000	N	문서 제목
zoneId	String	50	Y	검색 기간 기준 ZoneId zoneId 링크
startDt	String	10	Y	검색 기간 시작일 (YYYY-MM-DD), 검색기간은 최대 13개월
endDt	String	10	Y	검색 기간 종료일 (YYYY-MM-DD), 검색기간은 최대 13개월
dateType	String	20	N	기간 구분 코드 (기안일 : drft, 완료일 : cmplt), 미입력시, 기안일과 완료일 모두 검색
waitEmpId	String	36	N	결재 대기 중인 사원 ID
ingEmpId	String	36	N	결재할 사원 ID
prcsdEmpId	String	36	N	이미 결재한 사원 ID
drftEmpId	String	36	N	작성자 ID (작성자와 신청자는 대리상신이 아니면 동일함)
trgtEmpId	String	36	N	신청자 ID
trgtDeptCd	String	36	N	신청자 부서 코드
delYn	String	1	N	숨겨진 문서 여부
offset	long	9	N	offset row부터 출력 (최소 0)
limit	int	9	Y	limit 개수만큼 출력 (1~200)
locale	String	20	Y	검색 데이터 Locale Locale 링크

문서 상태 코드

상태	코드
전체
진행	ing
완료	cmplt
반려	decline
취소	cancel

zoneId

zoneId	설명
Pacific/Midway	GMT-11:00(MidwayIsland, Samoa)
Pacific/Honolulu	GMT-10:00(Hawaii)
Pacific/Marquesas	GMT-09:30(Marquesas)
America/Anchorage	GMT-09:00(Alaska)
America/Los_Angeles	GMT-08:00(PacificTime)
America/Denver	GMT-07:00(MountainTime_US/Canada)
America/Chicago	GMT-06:00(CentralTime_US/Canada)
America/New_York	GMT-05:00(EasternTime_US/Canada)
America/Caracas	GMT-04:30(Caracas)
America/Santiago	GMT-04:00(Santiago)
America/St_Johns	GMT-03:30(Newfoundland)
America/Sao_Paulo	GMT-03:00(SaoPaulo)
America/Noronha	GMT-02:00(Mid-Atlantic)
Atlantic/Azores	GMT-01:00(Azores)
Europe/London	GMT+00:00(GreenwichMeanTime_London)
Europe/Berlin	GMT+01:00(Amsterdam,Berlin, Vienna)
Europe/Athens	GMT+02:00(Athens, Cairo)
Asia/Baghdad	GMT+03:00(Moscow, Baghdad)
Asia/Tehran	GMT+03:30(Tehran)
Asia/Baku	GMT+04:00(Baku, Muscat)
Asia/Karachi	GMT+05:00(Karachi)
Asia/Colombo	GMT+05:30(NewDelhi,Mumbai, Colombo)
Asia/Katmandu	GMT+05:45(Katmandu)
Asia/Dhaka	GMT+06:00(Astana, Dhaka)
Asia/Rangoon	GMT+06:30(Rangoon)
Asia/Bangkok	GMT+07:00(Bangkok, Hanoi,Jakarta)
Asia/Shanghai	GMT+08:00(Beijing,Dalian, Singapore, Taiwan)
Asia/Seoul	GMT+09:00(Seoul)
Asia/Tokyo	GMT+09:00(Tokyo, Fukuoka)
Australia/Darwin	GMT+09:30(Darwin,Adelaide)
Australia/Sydney	GMT+10:00(Guam,Canberra, Sydney)
Australia/Lord_Howe	GMT+10:30(LordHoweIsland)
Pacific/Noumea	GMT+11:00(NewCaledonia)
Pacific/Norfolk	GMT+11:30(NorfolkIsland)
Pacific/Auckland	GMT+12:00(Auckland,Fiji)

Locale

언어	Locale
한국어	ko_KR
일본어	ja_JP
영어	en_US
중국어 간체	zh_CN
중국어 번체	zh_TW

요청 예시

GET https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/mngdocs

GET /workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/mngdocs?companyId=fe5f8382-aae3-4746-8d6e-f9d0545c5a9b&startDt=2020-01-02&endDt=2020-10-02&locale=ko_KR&limit=10&zoneId=Asia/Seoul
HOST: workplace.apigw.ntruss.com:443
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

응답 데이터

파라미터	타입	크기	필수 여부	설명
resultCode	Long	36	Y	결과 코드
resultMessage	Long	36	Y	결과 메시지
totalElements	int		Y	전체 데이터 건수
content	List		Y	데이터 리스트
aprvDocId	> Long	20	Y	결재 문서 ID
companyId	> String	36	N	회사 ID
companyNm	> String	1000	N	회사명
categoryId	> String	20	N	카테고리 ID
categoryNm	> String	1000	N	카테고리명
dfmId	> String	36	N	서식 ID
dfmNm	> String	1000	N	서식명
docNo	> String	100	N	문서 번호
docStatCd	> String	50	Y	문서 상태 코드
dfmTpCd	> String	50	Y	서식 구분 코드
dfmTpNm	> String	1000	N	서식 구분명
docTitle	> String	1000	N	문서 제목
shreTimeTpCd	> String	50	N	공유 시점 코드
shreOpninCnt	> int		N	공유 의견 개수
shreTpCd	> String	50	N	공유 구분 코드
drftEmpId	> String	36	N	작성자 ID
drftEmpNm	> String	1000	N	작성자명
drftEmpStatCd	> String	50	N	작성자 상태 코드
trgtEmpId	> String	36	N	신청자 ID
trgtEmpNm	> String	1000	N	신청자명
trgtEmpStatCd	> String	50	N	신청자 상태 코드
drftDt	> Date	50	N	작성 일시
cmpltDt	> Date	50	N	완료(거절) 일시
delYn	> String	1	Y	숨긴 문서 여부
aprvLine	> List		N	결재선
aprvOrd	>> int		N	결재순서
aprvEmpId	>> String	36	N	결재자 ID
aprvEmpNm	>> String	1000	N	결재자명
aprvEmpStatCd	>> String	50	N	결재자 상태 코드
aprvStatCd	>> String	50	N	결재 상태 코드
aprvTpCd	>> String	50	N	결재 유형 코드
docUri	> String	1000	N	문서 링크

응답 예시 (정상)

{
  "resultCode": "OK",
  "resultMessage": null,
  "content": [
    {
      "aprvDocId": 30493,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2004",
      "categoryNm": "기본",
      "dfmId": "D000000003",
      "dfmNm": "일반(ko)",
      "docNo": "2020_GEN01_000041",
      "docStatCd": "cmplt",
      "dfmTpCd": "8",
      "dfmTpNm": "채용계획서",
      "docTitle": "sdf",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "bee51313-5411-4a13-8850-a1db29dedf14",
      "drftEmpNm": "이세훈(한국)",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "bee51313-5411-4a13-8850-a1db29dedf14",
      "trgtEmpNm": "이세훈(한국)",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-25T03:07:22.000Z",
      "cmpltDt": "2020-09-25T03:07:23.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30493?at=WF"
    },
    {
      "aprvDocId": 30480,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "근무",
      "dfmId": "D000000007",
      "dfmNm": "근무 결과 신청",
      "docNo": "2020_TCS01_000177",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "근무 결과 신청 - 2020.09.25",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "allShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "그린이",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "그린이",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-25T02:26:57.000Z",
      "cmpltDt": "2020-09-25T02:26:58.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30480?at=WF"
    },
    {
      "aprvDocId": 30478,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000188",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "연차",
      "docTitle": "부재 일정(ko) - 연차 0.187일 2020.09.29(1시간30분)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:45.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30478?at=WF"
    },
    {
      "aprvDocId": 30477,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000187",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "연차",
      "docTitle": "부재 일정(ko) - 연차 0.125일 2020.09.28(1시간)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:33.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30477?at=WF"
    },
    {
      "aprvDocId": 30476,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000186",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "연차",
      "docTitle": "부재 일정(ko) - 연차 0.062일 2020.09.25(30분)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:19.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30476?at=WF"
    },
    {
      "aprvDocId": 30474,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "근무",
      "dfmId": "D000000009",
      "dfmNm": "근무 결과 신청 취소",
      "docNo": "2020_TCC01_000054",
      "docStatCd": "ing",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "관리자에 의한 홍길동.ko 근무 결과 취소",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "그린이",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "그린이",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:07:30.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30474?at=WF"
    },
    {
      "aprvDocId": 30473,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "근무",
      "dfmId": "D000000007",
      "dfmNm": "근무 결과 신청",
      "docNo": "2020_TCS01_000176",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "근무 결과 신청 - 2020.09.24",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:05:39.000Z",
      "cmpltDt": "2020-09-24T10:05:41.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30473?at=WF"
    },
    {
      "aprvDocId": 30471,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000185",
      "docStatCd": "decline",
      "dfmTpCd": "002",
      "dfmTpNm": "출장",
      "docTitle": "부재 일정(ko) - 출장 4일 2020.07.24 ~ 2020.07.27",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T09:08:10.000Z",
      "cmpltDt": "2020-09-24T09:14:03.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30471?at=WF"
    },
    {
      "aprvDocId": 30468,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000184",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "연차",
      "docTitle": "부재 일정(ko) - 연차 0.25일 2020.09.24(2시간)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:42:27.000Z",
      "cmpltDt": "2020-09-24T08:55:53.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30468?at=WF"
    },
    {
      "aprvDocId": 30467,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "인사",
      "dfmId": "D000000001",
      "dfmNm": "부재 일정(ko)",
      "docNo": "2020_TIM01_000183",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "연차",
      "docTitle": "부재 일정(ko) - 연차 0.125일 2020.09.23(1시간)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "홍길동.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "홍길동.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:41:49.000Z",
      "cmpltDt": "2020-09-24T08:45:29.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30467?at=WF"
    }
  ],
  "totalElements": 481
}

응답

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

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용 보통 서버가 이해할 수 없는 형식의 요청에 응답하기 위해 사용 4XX대의 오류 코드는 클라이언트 측 오류를 나타내기 위해 사용
401	Unauthorized	인증이 필요
403	Forbidden	서버요청거부
404	Not Found	요청한 페이지 찾을 수 없음
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

이 문서가 도움이 되었습니까?

What's Next

사용자권한 문서리스트 조회 v1

설명
조회 API
응답

태그

WORKPLACE