Compose Document Using Form Generator v2
- Print
- PDF
Compose Document Using Form Generator v2
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
It uses an API to create a document in a form created by the form generator.
Request URL
POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}/doc
Request Header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | |
| x-ncp-iam-access-key | Access key ID issued on the NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 |
Request Path Parameters
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | Integration key (companyId) Developers > Basic settings > Integration key |
| dfmId | String | 36 | Y | Form ID |
Request Body Parameters
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| title | String | 1000 | Y | Subject |
| dfmId | String | 36 | Y | Form ID |
| trgtCompanyId | String | 36 | Y | Requestor's company ID |
| trgtExternalKey | String | 36 | Y | Requestor ID - External key - Requires one from among WORKPLACE employee ID, external key, and login ID |
| trgtUserId | String | 36 | Y | Requestor WORKPLACE ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| trgtLoginId | String | 36 | Y | Requestor login ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| trgtDeptExternalKey | String | 36 | Y | Requestor department code - External key - Requires a WORKPLACE department code or external key |
| trgtDeptCd | String | 36 | Y | Requestor department code - Requires a WORKPLACE department code or external key |
| proxyYn | String | 1 | Y | Proxy request status- Default: N- If the applicant and the creator are different, enter Y and enter creator information. If the applicant and the creator are the same, the status is changed to N.- Write the item starting with drft shown below. |
| drftCompanyId | String | 36 | N | Creator's company ID |
| drftExternalKey | String | 36 | N | Creator ID - External key - Requires one from among WORKPLACE employee ID, external key, and login ID |
| drftUserId | String | 36 | N | Creator WORKPLACE ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| drftLoginId | String | 36 | N | Creator login ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| drftDeptExternalKey | String | 36 | N | Creator department code - External key - Requires a WORKPLACE department code or external key |
| drftDeptCd | String | 36 | Y | Creator department code - Requires a WORKPLACE department code or external key |
| aprvLineMngYn | String | 1 | Y | Manage Approval Line use status - Default: Y - Uses the approval line registered in Manage Approval Line.- Only head of superordinate department, manual input, or workplace manager can be used for Manage Approval Line. Reports To is only available when all employees have one person for Reports To. |
| aprvLineList | List | N | Approval line - If Manage Approval Line use status is N, then enter the approval line. - If there is no approval line, then the document is completed immediately upon saving.- Approval line details | |
| shreUsersMngYn | String | 1 | Y | Manage Shared Recipient use status - Default: Y - Uses shared recipient registered in Manage Shared Recipient. If N, then check the item related to share below. |
| shreTpCd | String | 20 | Y | Sharing option code - If Manage Shared Recipient use status is N, then this information is required.- allShre: share with all (If Sharing target code is comp, enter it as share with all.)- partShre: partially share (If there is no shared recipient, enter it as partially share and do not enter the sharing target information (shreUsersList).) |
| shreTimeTpCd | String | 20 | Y | Sharing time - If Manage Shared Recipient use status is N, then this information is required.- anyTime- cmpltTime |
| shreUserList | List | N | Sharing target information - If Manage Shared Recipient use status is N, enter the corporate ID when the sharing option is allShre, and enter according to the sharing recipient status when it is partShre. - Shared recipient details | |
| dataList | List | Y | Component data configured in the form body - Component dataList parameter |
Approval Line Details
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| aprvOrd | int | Y | Approval order (starting from 1) | |
| aprvParallelGrp | int | Y | Approval parallel group (same value for same group) (if not parallel, 0) | |
| aprvParallelDtlGrp | int | Y | Sequential group within the approval parallel group (if not parallel, 0) | |
| aprvParallelDtlOrd | int | Y | Sequential order within the approval parallel group (if not parallel, 0) | |
| aprvTpCd | String | 36 | Y | Approval type code- aprv Approval- refer Reference- agree Agreement- parallelAprv Parallel approval- parallelAgree Parallel agreement |
| aprvCompanyId | String | 36 | Y | Approver's company ID |
| aprvExternalKey | String | 36 | Y | Approver ID - External key - Requires one from among WORKPLACE employee ID, external key, and login ID |
| aprvUserId | String | 36 | Y | Approver WORKPLACE ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| aprvLoginId | String | 36 | Y | Approver login ID - Requires one from among WORKPLACE employee ID, external key, and login ID |
| aprvDeptExternalKey | String | 50 | N | Approver department code - External key - Requires a WORKPLACE department code or external key |
| aprvDeptCd | String | 50 | N | Approver department code - Requires a WORKPLACE department code or external key |
| defaultYn | String | 1 | N | Default approval line status - If Y, then this can't be edited or deleted if the user sets an approval line. |
Shared Recipient Details
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| shreObjectTpCd | String | 50 | Y | Sharing target code- user: employee- comp: company |
| shreCompanyId | String | 36 | Y | Company ID of shared recipient- Sharing target code: If user, company ID of shared recipient- Sharing target code: If comp, company ID to share with. |
| shreUserId | String | 36 | Y | WORKPLACE ID of shared recipient- Sharing target code: If user, then this requires a WORKPLACE employee ID, external key, or login ID. |
| shreExternalKey | String | 36 | Y | External key of shared recipient- Sharing target code: If user, then this requires a WORKPLACE employee ID, external key, or login ID. |
| shreLoginId | String | 36 | Y | Shared recipient login ID- Sharing target code: If user, then this requires a WORKPLACE employee ID, external key, or login ID. |
| shreDeptExternalKey | String | 50 | Y | Shared recipient department code - External key - Sharing target code: If user, this requires a WORKPLACE department code or external key. |
| shreDeptCd | String | 50 | Y | Shared recipient department code - Sharing target code: If user, this requires a WORKPLACE department code or external key. |
Component dataList Parameter
Component UUID can be searched through Approval > View Form > View Form Details API.
1. Basic Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentValue | String | 1000 | Y | Component value |
Supported component types
- [Text] component (CP_TEXT)
- [Multi-text] component (CP_MULTI_TEXT)
- [Number] component (CP_NUMBER)
- [Smart Editor] component (CP_EDITOR)
- [Automatically displayed text] component (CP_HIDDEN_TEXT)
- [Instruction text] component (CP_GUIDE)
- [Image] component (CP_IMG_STATIC)
- [Automatic number issuance] component (CP_AUTO_GENENUM)
- [Division line] component (CP_SECTION_LINE)
Note
- [Instruction text] component
- "Form Generator > Instruction Text > Detailed Settings > Printed Content Settings" value is automatically displayed.
- [Image] component
- The attached image is automatically displayed in "Form Generator > Image > Detailed Settings > Image Settings."
- [Automatic number issuance] component
- The set number is automatically displayed in "Form Generator > Automatic Number Issuance > Detailed Settings."
- [Division line] component
- The division line is automatically displayed.
Note
- [Automatically printed text] component
- It is available only if "Form Generator > Automatically Printed Text > Detailed Settings > API Integration" option is selected.
- Other options provided by the form generator aren't available.
- When requesting the API, the text entered in the componentValue field is saved and not displayed on the page.
- You can insert the "internal code" information that is not displayed on the page in the document using the component.
- It is available only if "Form Generator > Automatically Printed Text > Detailed Settings > API Integration" option is selected.
2. Table Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentHeader | String | 1000 | Y | Component header |
| componentBody | List | Y | Component body |
| componentHeader | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| cellUuid | String | 36 | Y | Header cell UUID |
| cellName | String | 36 | Y | Header cell name |
| cellType | String | 36 | Y | Header cell data type |
| componentBody | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| cellUuid | String | 36 | Y | Data cell UUID |
| cellValue | String | 36 | Y | Data cell value |
Supported component types
- [Table] component (CP_TABLE_FORM)
3. Formula Table Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentHeader | String | 1000 | Y | Component header |
| componentBody | List | Y | Component body |
| componentHeader | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| cellUuid | String | 36 | Y | Header cell UUID |
| cellName | String | 36 | Y | Header cell name |
| cellType | String | 36 | Y | Header cell data type |
| cellMode | String | 36 | Y | Header cell mode (data, calculation) |
| componentBody | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| cellUuid | String | 36 | Y | Data cell UUID |
| cellValue | String | 36 | Y | Data cell value |
Supported component types
- [Formula table] component (CP_TABLE_FORM_CAL)
Note
- Header cell mode (cellMode)
- Sets the data by default
- Sets the calculation for the calculation formula column
- For the calculation formula column, the cellValue value of the data cell doesn't need to be entered. (It's automatically calculated internally.)
4. File Attachment Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentAttachFile | List | Y | Component value |
| componentAttachFile | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| fileId | String | 36 | Y | Attachment file ID |
Supported component types
- [File attachment] component (CP_ATTACH_FILE)
Note
- To check the fileId, Common > File Attachment > Upload API must be called first.
- The file attachment component can be used only if the file upload task succeeds first.
5. Image Attachment Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentImageFile | List | Y | Component value |
| componentAttachFile | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| fileId | String | 36 | Y | Attachment file ID |
Supported component types.
- [Image attachment] component (CP_IMG)
Note
- To check the fileId, Common > File Attachment > Upload API must be called first.
- The file attachment component can be used only if the file upload task succeeds first.
- You can only use image files.
6. Components That Requires Item Selection
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentSelectedItem | List | Y | Component value |
| componentSelectedItem | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| selectedItemId | String | 36 | Y | Item UUID |
| selectedItemNm | String | 256 | Y | Item name |
Supported component types
- [Select box] component (CP_SELECTBOX)
- [Multi-select box] component (CP_MULTI_SELECTBOX)
- [Checkbox] component (CP_CHECKBOX)
- [Radio button] component (CP_RADIO)
Note
- When creating a document, the item name is displayed as the text defined in the form generator.
- Depending on the component type and options, it can be single or multiple item selection.
Note
- [Select box] component
- You can select "Form Generator > Select Box > Detailed Settings > Integration Code" option.
- In this case, you need to check [Detailed code] of the registered integration code from the Manage Approval > Manage Integration Code page and enter it as a value for the integration code.
- The integration code list can be changed in real time according to the integration code admin's settings.
7. Date Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentDateValue | Object | Y | Component value |
| componentDateValue | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| day | String | 256 | Y | Date (single) |
| startDay | String | 256 | Y | Date (range) start date |
| endDay | String | 256 | Y | Date (range) end date |
Supported component types
- [Date (single)] component (CP_DATE)
- [Date (range)] component (CP_RANGE_DATE)
Note
- Date (single) component
- Only the day attribute should be used as a parameter.
- Date (range) component
- Only the startDay and endDay attributes should be used as parameters.
- You need to follow the format for the date data.
- <Example> 2022.09.08
8. Time Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentTimeValue | Object | Y | Component value |
| componentTimeValue | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| time | String | 256 | Y | Time (single) |
| startTime | String | 256 | Y | Time (range) start time |
| endTime | String | 256 | Y | Time (range) end time |
Supported component types
- [Time (single)] component (CP_TIME)
- [Time (range)] component (CP_RANGE_TIME)
Note
- Time (single) component
- Only the time attribute should be used as a parameter.
- Time (range) component
- Only the startTime and endTime attributes should be used as parameters.
- You need to follow the format for the time data.
- <Example> 15:00
9. Address Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentAddrValue | Object | Y | Component value |
| componentAddrValue | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| krPost | String | 256 | Y | Zip code |
| krAddr1 | String | 256 | Y | Address |
| krAddr2 | String | 256 | Y | Detailed address |
Supported component types
- [Address] component (CP_ADDR_KR)
10. Related Document Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentRelDoc | List | Y | Component value |
| componentRelDoc | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| aprvDocId | String | 36 | Y | Approval ID |
| docType | String | 36 | Y | Document type (General document: NM) |
Supported component types
- [Related document] component (WCP_WP_DOC)
Note
- To check the aprvDocId, Approval > View Document List API must be called first.
- Currently, only general documents are supported.
11. Search Employees Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentEmp | List | Y | Component value |
| componentEmp | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| empId | String | 36 | Y | Employee ID |
Supported component types
- [Search employees] component (WCP_SEARCH_EMP)
Note
To check the empId, Member > View Employee API must be called first.
12. Search Department Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentDeptValue | List | Y | Component value |
| componentDeptValue | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| all | boolean | Y | Whether all departments are searched (All: true, Default: false) | |
| deptList | List | Y | Department Information |
| deptList | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| deptNo | String | 36 | Y | Department ID |
Supported component types
- [Search department] component (WCP_SEARCH_DEPT)
Note
To check the deptNo, Member > View Organization API must be called first.
13. Currency Components
| Item parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| componentUuid | String | 36 | Y | Component UUID |
| componentCode | String | 36 | Y | Component type code |
| componentCurrencyValue | List | Y | Component value |
| componentCurrencyValue | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| value | 36 | String | Y | Currency value |
| code | 36 | String | N | Currency code |
Supported component types
- [Currency] component (CP_CURRENCY)
Note
- If the "Currency settings" option is used in the form generator, then the "currency code" is ignored. (The currency code set in the form is used.)
- If the "Do not set currency" option is used, then the "currency code" is required.
- If the "Allow decimal point input" option is used in the form generator, then the "currency value" must follow the set number of decimal points.
- Currency value input when decimal points are not used
- <Example> 10000
- Currency value input when decimal points are used
- <Example> 10000.00
Response
It is returned as an HTTP status code and delivered as body information.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | General successful request |
| 201 | Created | Response code for successful resource creation |
| 400 | Bad Request | Used for general request failure |
| 500 | Internal Server Error |
Response Details
After checking the consistency of component input items, error codes and error messages are delivered for errors.
| Error code | Error message |
|---|---|
| 3000 | Required fields are not entered. |
| 3001 | The user doesn't exist. |
| 3002 | The department doesn't exist. |
| 3003 | The component value doesn't exist. |
| 3004 | It doesn't match the number of components in the form. |
| 3005 | The component UUID doesn't exist. |
| 3006 | The component property doesn't exist. |
| 3007 | The max number of characters that can be entered has been exceeded. |
| 3008 | Only one component value can be used. |
| 3009 | The component format doesn't match. |
| 3010 | The max number of files that can be attached has been exceeded. |
| 3011 | The max size of files that can be attached has been exceeded. |
| 3012 | This file has already been uploaded. |
| 3013 | This file extension is not allowed. |
| 3014 | Multiple selections are not available. |
| 3015 | Selection of all items is not available. |
| 3016 | The document information doesn't match. |
| 3016 | The document information doesn't match. |
| 3017 | The table column data is invalid. |
| 3018 | Required properties for API creation hasn't been set. |
| 3999 | Internal error has occurred in Approval. |
Response Examples
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"
}
Supported Language Codes
| Locale code | Description |
|---|---|
| ko_KR | Korean |
| ja_JP | Japanese |
| zh_CN | Chinese (Simplified) |
| zh_TW | Chinese (Traditional) |
| en_US | English |
Supported Currency Codes
| Currency code | Description |
|---|---|
| KRW | South Korean won |
| USD | U.S. dollar |
| CNY | Chinese yuan |
| JPY | Japanese yen |
| TWD | Taiwan dollar |
| EUR | European Union euro |
| GBP | British pound |
| AUD | Australian Dollar |
| CAD | Canadian dollar |
| NZD | New Zealand dollar |
| NOK | Norwegian krone |
| DKK | Danish krone |
| RUB | Russian ruble |
| MYR | Malaysian ringgit |
| MXN | Mexico |
| MNT | Mongolia |
| VND | Vietnamese dong |
| BRL | Brazil |
| SAR | Saudi Arabia |
| SEK | Sweden |
| CHF | Switzerland |
| INR | India |
| IDR | Indonesia |
| THB | Thai baht |
| PHP | Philippine peso |
| HKD | Hong Kong |
| ILS | Israel |
| AED | UAE dirham |
| BDT | Bangladesh |
| BHD | Bahrain |
| BND | Brunei |
| CZK | Czech Republic |
| EGP | Egypt |
| HUF | Hungary |
| JOD | Jordan |
| KWD | Kuwait |
| KZT | Kazakhstan |
| PKR | Pakistan |
| PLN | Poland |
| SGD | Singapore |
| TRY | Turkey |
| ZAR | South African rand |
Was this article helpful?