이관 문서 작성 v2

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

고객사의 문서를 이관하여 작성한다.

요청 URL

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/import/doc

요청 헤더

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

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

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
docNo	String	100	Y	문서 번호
dfmNm	String	100	Y	서식명
docTitle	String	1000	Y	제목
trgtUserNm	String	1000	Y	신청자
drftYmd	String	8	Y	신청일 (YYYYMMDD)
pdfFileId	String	36	N	본문 PDF 첨부파일 ID
registExternalKey	String	36	Y	등록자 ID - 외부키 - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
registUserId	String	36	Y	등록자 workplace ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
registLoginId	String	36	Y	등록자 로그인 ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
fileIdList	List		N	첨부파일 ID
aprvLineList	List		N	결재선 정보 - 결재선 상세 링크
shreTargetTpCd	String	20	N	공유대상 (공유자 정보 미 입력 시 공유 안됨.) - user : 일부 대상자 공유 - comp : 전체 대상자 공유
shreTargetList	List		N	공유자 정보 - 공유자 상세 링크

결재선 상세

파라메터	타입	크기	필수 여부	설명
aprvOrd	int		Y	결재 순서 (1부터 순차적으로 기입)
aprvUserNm	String	1000	Y	결재자명
aprvDt	String	20	Y	결재일시 (YYYY-MM-DD HH:MM:SS)

공유자 상세

파라메터	타입	크기	필수 여부	설명
shreUserCompanyId	String	36	Y	공유대상(user): 공유자 회사 ID
shreExternalKey	String	36	Y	공유대상(user): 공유자 외부키 - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreUserId	String	36	Y	공유대상(user): 공유자 workplace ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreLoginId	String	36	Y	공유대상(user): 공유자 로그인 ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreCompanyId	String	36	Y	공유대상(comp):공유 회사 ID (유효한 회사 ID)

요청 예시

POST /workflow/apigw/v2/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/import/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
  "docNo": "2022-EX001",
  "dfmNm": "일반기안지",
  "docTitle": "기안품의서",
  "trgtUserNm": "홍길동",
  "drftYmd": "20220820",
  "pdfFileId": "dbee1643-4c3e-47de-9b42-4166a42705ed",
  "registExternalKey": "",
  "registUserId": "96b02530-82de-41c8-8223-3055c74e705e",
  "registLoginId": "",
  "fileIdList": [
    "007d4fbc-dcaf-423c-9c15-fb3716be21e3",
    "0218bd02-402c-4fee-ba16-385665e00b67"
  ],
  "aprvLineList": [
    {
      "aprvOrd": 1,
      "aprvUserNm": "홍길동",
      "aprvDt": "2022-08-21 15:00:00"
    }
  ],
  "shreTargetTpCd": "user",
  "shreTargetList": [
    {
      "shreUserCompanyId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "shreExternalKey": "",
      "shreUserId": "",
      "shreLoginId": "admin@test.co.kr",
      "shreCompanyId": ""
    }
  ]
}

응답

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

HTTP 상태 코드	응답메시지	설명
200	OK	일반적인 요청 성공
201	Created	리소스 생성 성공에 대한 응답 코드
400	Bad Request	일반적인 요청 실패에 사용
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용됨 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨

응답 예시

HTTP/1.1 200 OK
Server: nginx
date: Sun21 Aug 2022 05:37:34 GMT 
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "docId": "22541"
}

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

What's Next

외부 결재 문서 작성 v2

설명
응답

태그

WORKPLACE