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

설명

관리자 권한으로 조회 가능한 결재문서를 조회하기 위한 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-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 > 기본 설정 > 연동키

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 회사 ID
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 N 검색 기간 기준 ZoneId
startDt String 8 Y 검색 기간 시작일
endDt String 8 Y 검색 기간 종료일
dateType String 20 N 기간 구분 코드 (drft, cmplt)
waitEmpId String 36 N 결재 대기중인 사원 ID
ingEmpId String 36 N 결재할 사원 ID
prcsdEmpId String 36 N 이미 결재한 사원 ID
sort String 20 N 정렬 (ex: -docNo, +docTitle)
drftEmpId String 36 N 작성자 ID
trgtEmpId String 36 N 신청자 ID
trgtDeptCd String 36 N 신청자 부서 코드
delYn String 1 N 숨겨진 문서 여부
approverDocYn String 1 N 처리자인 문서 포함 여부
shareDocYn String 1 N 공유 받은 문서 포함 여부
offset long 9 N 페이지 번호
limit int 9 N 페이지당 건수
locale String 20 Y 검색 데이터 Locale
empExternalKey String 100 N empExternalKey
emailId String 100 N email ID

요청 예시

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

GET /workflow/apigw/v1/company/52e6e775-6993-424d-bc58-62e17268ed29/emp/docs
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=

응답 파라미터

파라미터 타입 크기 필수 여부 설명
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": 23945,
      "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "companyNm": "ABC Corp.",
      "categoryId": "1975",
      "categoryNm": "비용",
      "dfmId": "D100000002",
      "dfmNm": "비용 정산 신청",
      "docNo": "2019-EXP01-000277",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "토요일에 사용한 비용",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "allShre",
      "drftEmpId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "drftEmpNm": "홍길동",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "trgtEmpNm": "홍길동",
      "trgtEmpStatCd": "IN",
      "drftDt": "2019-12-12T05:42:13.000Z",
      "cmpltDt": "2019-12-12T05:42:14.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://abcd.ncpworkplace.com/user/view/doc/23945?at=WF"
    }
  ],
  "totalElements": 395
}

응답

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

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