서식생성기 문서 작성 v2

인쇄
공유
PDF

서식생성기 문서 작성 v2

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

API를 이용하여 서식생성기에서 생성한 서식의 문서를 작성합니다.

요청 URL

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}/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 > 기본 설정 > 연동키
dfmId	String	36	Y	서식ID

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
title	String	1000	Y	제목
dfmId	String	36	Y	서식ID
trgtCompanyId	String	36	Y	신청자 회사 ID
trgtExternalKey	String	36	Y	신청자 ID - 외부키 - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
trgtUserId	String	36	Y	신청자 workplace ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
trgtLoginId	String	36	Y	신청자 로그인 ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
trgtDeptExternalKey	String	36	Y	신청자 부서 코드 - 외부키 - workplace 부서코드 또는 외부키 둘중 하나 필수
trgtDeptCd	String	36	Y	신청자 부서 코드 - workplace 부서코드 또는 외부키 둘중 하나 필수
proxyYn	String	1	Y	대리 신청 여부- 디폴트 : N- 신청자와 작성자가 다른 경우 Y로 입력하고 작성자 정보들을 입력한다. 신청자와 작성자가 같은 경우 N으로 변경됨- 아래쪽 drft로 시작하는 항목를 작성
drftCompanyId	String	36	N	작성자 회사 ID
drftExternalKey	String	36	N	작성자 ID - 외부키 - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
drftUserId	String	36	N	작성자 workplace ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
drftLoginId	String	36	N	작성자 로그인 ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
drftDeptExternalKey	String	36	N	작성자 부서 코드 - 외부키 - workplace 부서코드 또는 외부키 둘중 하나 필수
drftDeptCd	String	36	Y	작성자 부서 코드 - workplace 부서코드 또는 외부키 둘중 하나 필수
aprvLineMngYn	String	1	Y	결재선 관리 사용여부 - 디폴트 : Y - 결재선 관리에 등록된 결재선을 사용- 결재선 관리에 상위부서장, 직접입력, 근무지 매니저만 사용 가능함. Reports To는 모든 직원이 reports to 가 1명일때만 사용가능함.
aprvLineList	List		N	결재선 - 결재선 관리 사용여부가 N일때, 결재선 입력 - 결재선이 없으면 저장 시, 바로 문서가 완료됨- 결재선 상세
shreUsersMngYn	String	1	Y	공유자 관리 사용여부 - 디폴트 : Y - 공유자 관리에 등록된 공유자를 사용, N이면 아래 share 관련 항목을 확인하세요.
shreTpCd	String	20	Y	공유 범위 코드 - 공유자 관리 사용여부가 N이면 필수 입력- allShre : 전체공유 (공유 대상 코드가 comp 일 경우, 전체공유로 입력)- partShre : 일부공유 (공유자가 없을때, 일부공유로 입력하고 공유대상정보(shreUsersList) 를 작성하지 않는다)
shreTimeTpCd	String	20	Y	공유 시점 - 공유자 관리 사용여부가 N이면 필수 입력- anyTime- cmpltTime
shreUserList	List		N	공유대상정보 - 공유자 관리 사용여부가 N일때, 공유범위 : allShre 이면 법인ID 등록, partShre 이면 공유자 여부에 따라 등록 - 공유자 상세
dataList	List		Y	서식 본문을 구성하고 있는 컴포넌트 데이터 - 컴포넌트 dataList 파라미터

결재선 상세

파라메터	타입	크기	필수 여부	설명
aprvOrd	int		Y	결재 순서 (1부터)
aprvParallelGrp	int		Y	결재 병렬 그룹 (같은 그룹이면 동일한 값) (병렬아니면 0)
aprvParallelDtlGrp	int		Y	결재 병렬 그룹내 순차그룹 (병렬아니면 0)
aprvParallelDtlOrd	int		Y	결재 병렬 그룹내 순차 순서 (병렬아니면 0)
aprvTpCd	String	36	Y	결재 유형 코드- aprv 결재- refer 참조- agree 합의- parallelAprv 병렬결재- parallelAgree 병렬합의
aprvCompanyId	String	36	Y	결재자 회사 ID
aprvExternalKey	String	36	Y	결재자 ID - 외부키 - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
aprvUserId	String	36	Y	결재자 workplace ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
aprvLoginId	String	36	Y	결재자 로그인 ID - workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
aprvDeptExternalKey	String	50	N	결재자 부서 코드 - 외부키 - workplace 부서코드 또는 외부키 둘중 하나 필수
aprvDeptCd	String	50	N	결재자 부서 코드 - workplace 부서코드 또는 외부키 둘중 하나 필수
defaultYn	String	1	N	기본결재선 여부 - Y이면 사용자가 결재선 설정 시, 수정/삭제할 수 없음

공유자 상세

파라메터	타입	크기	필수 여부	설명
shreObjectTpCd	String	50	Y	공유 대상 코드- user 사원- comp 회사
shreCompanyId	String	36	Y	공유 대상자 회사 ID- 공유 대상 코드 : user 이면, 공유자의 소속 회사 ID- 공유 대상 코드 : comp 이면, 공유할 회사 ID
shreUserId	String	36	Y	공유자 workplace ID- 공유 대상 코드 : user 일때, workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreExternalKey	String	36	Y	공유자 외부키- 공유 대상 코드 : user 일때, workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreLoginId	String	36	Y	공유자 로그인 ID- 공유 대상 코드 : user 일때, workplace 사원ID 또는 외부키 또는 로그인ID 중 하나 필수
shreDeptExternalKey	String	50	Y	공유자 부서 코드 - 외부키 - 공유 대상 코드 : user 일때, workplace 부서코드 또는 외부키 둘중 하나 필수
shreDeptCd	String	50	Y	공유자 부서 코드 - 공유 대상 코드 : user 일떄, workplace 부서코드 또는 외부키 둘중 하나 필수

컴포넌트 dataList 파라미터

컴포넌트의 UUID는 결재 > 서식 조회 > 서식 상세 조회 API를 통해 조회 가능하다.

1. 기본 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentValue	String	1000	Y	컴포넌트 값

지원하는 컴포넌트 종류

[텍스트] 컴포넌트 (CP_TEXT)
[멀티텍스트] 컴포넌트 (CP_MULTI_TEXT)
[숫자] 컴포넌트 (CP_NUMBER)
[스마트 에디터] 컴포넌트 (CP_EDITOR)
[자동 출력 텍스트] 컴포넌트 (CP_HIDDEN_TEXT)
[안내문구] 컴포넌트 (CP_GUIDE)
[이미지] 컴포넌트 (CP_IMG_STATIC)
[자동번호발급] 컴포넌트 (CP_AUTO_GENENUM)
[구분선] 컴포넌트 (CP_SECTION_LINE)

참고

[안내문구] 컴포넌트
- "서식생성기 > 안내문구 > 상세설정 > 출력내용설정" 값이 자동 표시된다.
[이미지] 컴포넌트
- "서식생성기 > 이미지 > 상세설정 > 이미지설정"에 첨부된 이미지가 자동 표시된다.
[자동번호발급] 컴포넌트
- "서식생성기 > 자동번호발급 > 상세설정"에 설정된 번호가 자동 표시된다.
[구분선] 컴포넌트
- 구분선이 자동 표시됩니다.

참고

[자동 출력 텍스트] 컴포넌트
- "서식생성기 > 자동출력텍스트 > 상세설정 > API 연동" 옵션을 선택해야만 사용할수 있다.
  - 서식생성기에서 제공되는 다른 옵션은 사용할 수 없다.
- API 요청시 componentValue 항목으로 입력된 텍스트가 저장되며 화면상에 노출되지 않는다.
- 해당 컴포넌트를 이용하여 화면상에서는 보이지 않는 "내부 코드" 정보를 문서에 삽입할 수 있다.

2. 테이블 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentHeader	String	1000	Y	컴포넌트 Header
componentBody	List		Y	컴포넌트 Body

componentHeader	타입	크기	필수 여부	설명
cellUuid	String	36	Y	헤더 셀 UUID
cellName	String	36	Y	헤더 셀 이름
cellType	String	36	Y	헤더 셀 데이터타입

componentBody	타입	크기	필수 여부	설명
cellUuid	String	36	Y	데이터 셀 UUID
cellValue	String	36	Y	데이터 셀 값

지원하는 컴포넌트 종류

[테이블] 컴포넌트 (CP_TABLE_FORM)

3. 수식테이블 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentHeader	String	1000	Y	컴포넌트 Header
componentBody	List		Y	컴포넌트 Body

componentHeader	타입	크기	필수 여부	설명
cellUuid	String	36	Y	헤더 셀 UUID
cellName	String	36	Y	헤더 셀 이름
cellType	String	36	Y	헤더 셀 데이터타입
cellMode	String	36	Y	헤더 셀 모드 (data, calculation)

componentBody	타입	크기	필수 여부	설명
cellUuid	String	36	Y	데이터 셀 UUID
cellValue	String	36	Y	데이터 셀 값

지원하는 컴포넌트 종류

[수식테이블] 컴포넌트 (CP_TABLE_FORM_CAL)

참고

헤더 셀 모드 (cellMode)
- 기본적으로 data를 설정
- 계산식열일 경우 calculation 설정
계산식열일 경우 데이터 셀의 cellValue 값을 넣지 않아도 된다. (내부에서 자동계산)

4. 파일첨부 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentAttachFile	List		Y	컴포넌트 값

componentAttachFile	타입	크기	필수 여부	설명
fileId	String	36	Y	첨부파일 ID

지원하는 컴포넌트 종류

[파일첨부] 컴포넌트 (CP_ATTACH_FILE)

참고

fileId를 알기 위해서 공통 > 첨부파일 > 업로드 API를 먼저 호출해야 한다.
파일 업로드 작업이 먼저 성공해야 파일첨부 컴포넌트를 사용할 수 있다.

5. 이미지첨부 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentImageFile	List		Y	컴포넌트 값

componentAttachFile	타입	크기	필수 여부	설명
fileId	String	36	Y	첨부파일 ID

지원하는 컴포넌트 종류.

[이미지첨부] 컴포넌트 (CP_IMG)

참고

fileId를 알기 위해서 공통 > 첨부파일 > 업로드 API를 먼저 호출해야 한다.
파일 업로드 작업이 먼저 성공해야 파일첨부 컴포넌트를 사용할 수 있다.
이미지 타입의 파일만 사용할 수 있다.

6. Item 선택이 필요한 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentSelectedItem	List		Y	컴포넌트 값

componentSelectedItem	타입	크기	필수 여부	설명
selectedItemId	String	36	Y	Item UUID
selectedItemNm	String	256	Y	Item 이름

지원하는 컴포넌트 종류

[셀렉트박스] 컴포넌트 (CP_SELECTBOX)
[멀티셀렉트박스] 컴포넌트 (CP_MULTI_SELECTBOX)
[체크박스] 컴포넌트 (CP_CHECKBOX)
[라디오버튼] 컴포넌트 (CP_RADIO)

참고

문서 생성 시 Item 이름은 서식생성기에 정의된 Text로 표시된다.
컴포넌트 종류와 옵션에 따라서 Item 선택이 1건이 될수도 여러건이 될수도 있다.

참고

[셀렉트박스] 컴포넌트
- "서식생성기 > 셀렉트박스 > 상세설정 > 연동 코드" 옵션을 선택하는 것이 가능하다.
- 이경우 연동코드는 결재관리 > 연동코드 관리 화면에서 등록된 연동코드의 [세부코드]를 확인해서 값으로 넣어야 한다.
- 연동코드 리스트는 연동코드 관리자의 설정에 따라 실시간으로 변경될 수 있다.

7. 날짜 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentDateValue	Object		Y	컴포넌트 값

componentDateValue	타입	크기	필수 여부	설명
day	String	256	Y	날짜(단일)
startDay	String	256	Y	날짜(범위) 시작일
endDay	String	256	Y	날짜(범위) 종료일

지원하는 컴포넌트 종류

[날짜(단일)] 컴포넌트 (CP_DATE)
[날짜(범위)] 컴포넌트 (CP_RANGE_DATE)

참고

날짜(단일) 컴포넌트
- 파라메터로 day 속성만 사용해야 한다.
날짜(범위) 컴포넌트
- 파라메터로 startDay, endDay 속성만 사용해야 한다.
날짜 데이터는 포맷을 지켜야 한다.
- <예시> 2022.09.08

8. 시간 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentTimeValue	Object		Y	컴포넌트 값

componentTimeValue	타입	크기	필수 여부	설명
time	String	256	Y	시간(단일)
startTime	String	256	Y	시간(범위) 시작시간
endTime	String	256	Y	시간(범위) 종료시간

지원하는 컴포넌트 종류

[시간(단일)] 컴포넌트 (CP_TIME)
[시간(범위)] 컴포넌트 (CP_RANGE_TIME)

참고

시간(단일) 컴포넌트
- 파라메터로 time 속성만 사용해야 한다.
시간(범위) 컴포넌트
- 파라메터로 startTime, endTime 속성만 사용해야 한다.
시간 데이터는 포맷을 지켜야 한다.
- <예시> 15:00

9. 주소 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentAddrValue	Object		Y	컴포넌트 값

componentAddrValue	타입	크기	필수 여부	설명
krPost	String	256	Y	우편번호
krAddr1	String	256	Y	주소
krAddr2	String	256	Y	상세주소

지원하는 컴포넌트 종류

[주소] 컴포넌트 (CP_ADDR_KR)

10. 연관문서 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentRelDoc	List		Y	컴포넌트 값

componentRelDoc	타입	크기	필수 여부	설명
aprvDocId	String	36	Y	결재ID
docType	String	36	Y	문서종류 (일반문서 : NM)

지원하는 컴포넌트 종류

[연관문서] 컴포넌트 (WCP_WP_DOC)

참고

aprvDocId를 알기 위해서 결재 > 문서 리스트 조회 API를 먼저 호출해야 한다.
현재는 일반문서만 지원이 가능하다.

11. 사원 검색 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentEmp	List		Y	컴포넌트 값

componentEmp	타입	크기	필수 여부	설명
empId	String	36	Y	사원ID

지원하는 컴포넌트 종류

[사원검색] 컴포넌트 (WCP_SEARCH_EMP)

참고

empId를 알기 위해서 구성원 > 사원 조회 API를 먼저 호출해야 한다.

12. 부서검색 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentDeptValue	List		Y	컴포넌트 값

componentDeptValue	타입	크기	필수 여부	설명
all	boolean		Y	전체여부 (전체 : true, 기본 : false)
deptList	List		Y	부서 정보

deptList	타입	크기	필수 여부	설명
deptNo	String	36	Y	부서ID

지원하는 컴포넌트 종류

[부서검색] 컴포넌트 (WCP_SEARCH_DEPT)

참고

deptNo를 알기 위해서 구성원 > 조직 조회 API를 먼저 호출해야 한다.

13. 통화 컴포넌트

ITEM 파라메터	타입	크기	필수 여부	설명
componentUuid	String	36	Y	컴포넌트 UUID
componentCode	String	36	Y	컴포넌트 종류 코드
componentCurrencyValue	List		Y	컴포넌트 값

componentCurrencyValue	타입	크기	필수 여부	설명
value	36	String	Y	통화 값
code	36	String	N	통화 코드

지원하는 컴포넌트 종류

[통화] 컴포넌트 (CP_CURRENCY)

참고

서식생기에서 "통화 설정" 옵션을 사용하는 경우 "통화 코드"는 무시된다. (서식내 설정된 통화 코드 사용)
"통화 설정안함" 옵션을 사용하는 경우 "통화 코드"는 필수이다.
서식생성기에서 "소수점 입력 허용" 옵션을 사용하는 경우 "통화 값"은 설정된 소수점 자리수를 반드시 지켜야 한다.
소수점 미사용시 통화값 입력값
- <예시> 10000
소수점 사용시 통화값 입력값
- <예시> 10000.00

응답

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

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

응답 상세

컴포넌트 입력 항목에 대해 정합성 체크 후 오류에 대해 에러코드와 에러메시지가 전달된다.

에러코드	에러메시지
3000	필수 항목이 입력되지 않음
3001	존재하지 않는 사용자
3002	존재하지 않는 부서
3003	존재하지 않는 컴포넌트 값
3004	서식에 존재하는 컴포넌트 개수와 일치하지 않음
3005	존재하지 않는 컴포넌트 UUID
3006	존재하지 않는 컴포넌트 속성
3007	입력할 수 있는 최대 글자 수 초과
3008	컴포넌트 값은 1개만 사용 가능
3009	컴포넌트 포맷이 일치하지 않음
3010	첨부 가능한 파일 최대 개수 초과
3011	첨부 가능한 파일 크기 초과
3012	이미 업로드된 파일
3013	허용되지 않은 파일 확장자
3014	복수 선택 불가능
3015	전체 선택 불가능
3016	문서 정보가 일치하지 않음
3016	문서 정보가 일치하지 않음
3017	테이블 컬럼 데이터가 유효하지 않음
3018	API 작성 시 반드시 필요한 속성이 설정되지 않음
3999	결재 내부에서 오류 발생

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
    "dfmId": "7ba9b979-024f-4b09-8551-4e638dde0bae",
    "docId": "22541"
}

지원하는 언어 코드

locale 코드	설명
ko_KR	한국어
ja_JP	일본어
zh_CN	중국어(간체)
zh_TW	중국어(번체)
en_US	영어

지원하는 통화 코드

통화 코드	설명
KRW	대한민국 원
USD	미국 달러
CNY	중국 위안
JPY	일본 엔
TWD	대만 달러
EUR	유럽연합 유로
GBP	영국 파운드
AUD	호주 달러
CAD	캐나다 달러
NZD	뉴질랜드 달러
NOK	노르웨이 크로네
DKK	덴마크 크로네
RUB	러시아 루블
MYR	말레이시아 링깃
MXN	멕시코
MNT	몽골
VND	베트남 동
BRL	브라질
SAR	사우디아라비아
SEK	스웨덴
CHF	스위스
INR	인도
IDR	인도네시아
THB	태국 바트
PHP	필리핀 페소
HKD	홍콩
ILS	이스라엘
AED	아랍에미리트 디르함
BDT	방글라데시
BHD	바레인
BND	브루나이
CZK	체코
EGP	이집트
HUF	헝가리
JOD	요르단
KWD	쿠웨이트
KZT	카자흐스탄
PKR	파키스탄
PLN	폴란드
SGD	싱가포르
TRY	터키
ZAR	남아프리카공화국 랜드

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

What's Next

서식생성기 문서 작성 v2 Example

설명
응답
응답 상세
지원하는 언어 코드
지원하는 통화 코드

태그

WORKPLACE