Create document using form generator v2 example

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

It describes examples of Create document using form generator API.

Approval line

Request example 1

The simplest example is as follows.

Using the approval line feature set in management
Using the shared recipient feature set in management
Component body (simple)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a simple approval document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_TEXT",
			"componentValue": "Seoul"
		}
	]
}

Request example 2

The simplest example is as follows.

Manual input of approval line
Using the shared recipient feature set in management
Component body (simple)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	

	"title": "Proposes a document whose approval line is set manually.",
	"dfmId": "cc84deb4-4758-4762-a6c8-1f223cac5b27",
	"proxyYn": "N",
	"trgtCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
	"trgtExternalKey": "70cba748-40f8-4a02-9cd6-9510c044022d",
	"trgtDeptCd": "cgv2008000665",	
	"aprvLineMngYn": "N",
	"aprvLineList":[
		{
			"aprvOrd": 1,
			"aprvParallelGrp": 0,
			"aprvParallelDtlGrp":0,
			"aprvParallelDtlOrd":0,
			"aprvTpCd": "aprv",
			"aprvCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
			"aprvExternalKey": "000d6d2c-1c48-4f11-a393-63003d3702e1",
			"aprvDeptCd": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
			"defaultYn": "Y"
		},
		{
			"aprvOrd": 2,
			"aprvParallelGrp": 0,
			"aprvParallelDtlGrp":0,
			"aprvParallelDtlOrd":0,
			"aprvTpCd": "refer",
			"aprvCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
			"aprvExternalKey": "07d3352d-bbac-40c1-9113-d18fdbc484d0",
			"aprvDeptCd": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
			"defaultYn": "Y"
		}
	],
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_TEXT",
			"componentValue": "Seoul"
		}
	]
}

Shared recipient

Request example 1

The simplest example is as follows.

Using the approval line feature set in management
Using the shared recipient feature set in management
Component body (simple)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a simple approval document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_TEXT",
			"componentValue": "Seoul"
		}
	]
}

Request example 2

The simplest example is as follows.

Using the approval line feature set in management
Manual input of shared recipient
Component body (simple)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a document whose sharing settings are set manually.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "N",
	"shreTpCd": "allShre",
	"shreTimeTpCd": "anyTime",
	"shreUserList":[
		{
			"shreObjectTpCd": "comp",
			"shreCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6"
		}
	],
    "dataList":[
		{
			"componentUuid": "0b1db6ba-1d0e-3b15-b09f-b573d0c4d791",
			"componentCode": "CP_TEXT",
			"componentValue": "Seoul"
		}
	]
}

Basic components

Request examples

COMPONET BODY

[Text] component (CP_TEXT)
[Multi-text] component (CP_MULTI_TEXT): Add code (\n) when a line break is required.
[Number] component (CP_NUMBER)
[Smart Editor] component (CP_EDITOR)
[Automatically displayed text] component (CP_HIDDEN_TEXT)
[Instruction text] component (CP_GUIDE): Component value does not exist.
[Image] component (CP_IMG_STATIC): Component value does not exist.
[Automatic number issuance] component (CP_AUTO_GENENUM): Component value does not exist.
[Division line] component (CP_SECTION_LINE): Component value does not exist.

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a basic component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_TEXT",
			"componentValue": "Seoul"
		},
		{
			"componentUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
			"componentCode": "CP_MULTI_TEXT",
			"componentValue": "Seoul\nDaejeon\nDaegu\nBusan\n"
		},
		{
			"componentUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
			"componentCode": "CP_NUMBER",
			"componentValue": "123456"
		},
		{
			"componentUuid": "c71747a6-e1f8-73cb-e069-b8de7c101c3a",
			"componentCode": "CP_EDITOR",
			"componentValue": "<b>Hello</b>"
		},
		{
			"componentUuid": "b0f41473-8d7b-1c57-4739-bb9db67e6564",
			"componentCode": "CP_HIDDEN_TEXT",
			"componentValue": "code=I000021"
		},
		{
			"componentUuid": "46bece19-cf6b-d721-d314-c794ead51657",
			"componentCode": "CP_GUIDE"
		},
        {
			"componentUuid": "6e62b739-05df-a12a-38c4-5fbc1e364a77",
			"componentCode": "CP_IMG_STATIC"
		},
        {
			"componentUuid": "1e62b739-05df-a12a-38c4-5fbc1e364a77",
			"componentCode": "CP_AUTO_GENENUM"
		},
        {
			"componentUuid": "2e62b739-05df-a12a-38c4-5fbc1e364a77",
			"componentCode": "CP_SECTION_LINE"
		}
	]
}

Table component

Request examples

COMPONET BODY

[Table] component (CP_TABLE_FORM)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a table component document.",
	"dfmId": "7c361f7d-95ea-4b6e-aaca-0b617565f337",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "6282848b-2c52-f938-0c42-6e7dbb1216c3",
			"componentCode": "CP_TABLE_FORM",
			"componentHeader": [{
				"cellUuid": "fcf70315-519f-6ffe-0237-4893f82b42c9",
				"cellName": "Label 1",
				"cellType": "text"
			},{
				"cellUuid": "e1683411-2fbe-0360-2eed-125398b2fe93",
				"cellName": "Label 2",
				"cellType": "number"
			},{
				"cellUuid": "55395ee6-461f-8cd5-b615-b84d97658abc",
				"cellName": "Label 3",
				"cellType": "date"
			},{
				"cellUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
				"cellName": "Label 4",
				"cellType": "combo"
			},{
				"cellUuid": "46bece19-cf6b-d721-d314-c794ead51657",
				"cellName": "Label 5",
				"cellType": "multiCombo"
			}],
			"componentBody": [{
				"rowNum": "1",
				"rowData": [{
					"cellUuid": "fcf70315-519f-6ffe-0237-4893f82b42c9",
					"cellValue": "Apple"
				},{	
					"cellUuid": "e1683411-2fbe-0360-2eed-125398b2fe93",
					"cellValue": "100"
				},{	
					"cellUuid": "55395ee6-461f-8cd5-b615-b84d97658abc",
					"cellValue": "2021.12.05"
				},{	
					"cellUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
					"cellValue": "7377b35b-078a-7b52-badd-8a1385a56f47"
				},{	
					"cellUuid": "46bece19-cf6b-d721-d314-c794ead51657",
					"cellValue": "ed66db57-a539-aa05-68a8-9cc8ed401d0c,ac418a2d-9f9d-9a0a-fc13-f291fce6cb4e"
				}]
			},{
				"rowNum": "2",
				"rowData": [{
					"cellUuid": "fcf70315-519f-6ffe-0237-4893f82b42c9",
					"cellValue": "Grape"
				},{	
					"cellUuid": "e1683411-2fbe-0360-2eed-125398b2fe93",
					"cellValue": "200"
				},{	
					"cellUuid": "55395ee6-461f-8cd5-b615-b84d97658abc",
					"cellValue": "2021.12.06"
				},{	
					"cellUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
					"cellValue": "7377b35b-078a-7b52-badd-8a1385a56f47"
				},{	
					"cellUuid": "46bece19-cf6b-d721-d314-c794ead51657",
					"cellValue": "ed66db57-a539-aa05-68a8-9cc8ed401d0c,ac418a2d-9f9d-9a0a-fc13-f291fce6cb4e"
				}]				
			}] 			
		}
	]


}

Formula table component

Request examples

COMPONET BODY

[Formula table] component (CP_TABLE_FORM_CAL)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a formula table component document.",
	"dfmId": "ef4855c9-b093-4b82-b961-e8ed665f6d1a",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "d73006ad-11ab-21f2-4605-ed342bac6d63",
			"componentCode": "CP_TABLE_FORM_CAL",
			"componentHeader": [{
				"cellUuid": "e7ff080b-0e63-a806-01f4-25ff50d711a8",
				"cellName": "Item",
				"cellType": "text",
				"cellMode": "data"
			},{
				"cellUuid": "b97e1b67-fbe4-693f-ba73-1886a8cb86ea",
				"cellName": "Unit price",
				"cellType": "number",
				"cellMode": "data"
			},{
				"cellUuid": "10c87fdc-1852-f529-e9d5-4685ac96535b",
				"cellName": "Quantity",
				"cellType": "number",
				"cellMode": "data"
			},{
				"cellUuid": "8b1b146c-b2f0-b37b-2765-542d39a08a6f",
				"cellName": "Purchase price",
				"cellType": "number",
				"cellMode": "calculation"
			}],
			"componentBody": [{
				"rowNum": "1",
				"rowData": [{
					"cellUuid": "e7ff080b-0e63-a806-01f4-25ff50d711a8",
					"cellValue": "Pumpkin"
				},{	
					"cellUuid": "b97e1b67-fbe4-693f-ba73-1886a8cb86ea",
					"cellValue": "1000"
				},{	
					"cellUuid": "10c87fdc-1852-f529-e9d5-4685ac96535b",
					"cellValue": "5"
				},{	
					"cellUuid": "8b1b146c-b2f0-b37b-2765-542d39a08a6f",
					"cellValue": ""
				}]
			},{
				"rowNum": "2",
				"rowData": [{
					"cellUuid": "e7ff080b-0e63-a806-01f4-25ff50d711a8",
					"cellValue": "Sweet potato"
				},{	
					"cellUuid": "b97e1b67-fbe4-693f-ba73-1886a8cb86ea",
					"cellValue": "2000"
				},{	
					"cellUuid": "10c87fdc-1852-f529-e9d5-4685ac96535b",
					"cellValue": "10"
				},{	
					"cellUuid": "8b1b146c-b2f0-b37b-2765-542d39a08a6f",
					"cellValue": ""
				}]				
			}] 			
		}
	]
}

File attachment component

Request examples

COMPONET BODY

[File attachment] component (CP_ATTACH_FILE)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a file attachment component document.",
	"dfmId": "ef4855c9-b093-4b82-b961-e8ed665f6d1a",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "d73006ad-11ab-21f2-4605-ed342bac6d63",
			"componentCode": "CP_ATTACH_FILE",
			"componentAttachFile": [{
				"fileId": "22541"
			},{
				"fileId": "22542"		
			}] 			
		}
	]
}

Image attachment component

Request examples

COMPONET BODY

[Image attachment] component (CP_IMG)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/cc84deb4-4758-4762-a6c8-1f223cac5b27/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes an image attachment component document.",
	"dfmId": "ef4855c9-b093-4b82-b961-e8ed665f6d1a",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "d73006ad-11ab-21f2-4605-ed342bac6d63",
			"componentCode": "CP_IMG",
			"componentImageFile": [{
				"fileId": "32541"
			},{
				"fileId": "32542"		
			}] 			
		}
	]
}

Item component

Request examples

COMPONET BODY

[Select box] component (CP_SELECTBOX)
[Multi-select box] component (CP_MULTI_SELECTBOX)
[Checkbox] component (CP_CHECKBOX)
[Radio button] component (CP_RADIO)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a component document with an item.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_SELECTBOX",
			"componentSelectedItem": [{
				"selectedItemId": "CD001",
				"selectedItemNm": "Potato"
			}] 	
		},
		{
			"componentUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
			"componentCode": "CP_MULTI_SELECTBOX",
			"componentSelectedItem": [{
				"selectedItemId": "CD001",
				"selectedItemNm": "Potato"
			},{
				"selectedItemId": "CD002",
				"selectedItemNm": "Cucumber"		
			}] 	
		},
		{
			"componentUuid": "b0f41473-8d7b-1c57-4739-bb9db67e6564",
			"componentCode": "CP_CHECKBOX",
			"componentSelectedItem": [{
				"selectedItemId": "A101",
				"selectedItemNm": "Code 101"
			},{
				"selectedItemId": "A564",
				"selectedItemNm": "Code 564"
			},{
				"selectedItemId": "A004",
				"selectedItemNm": "Code 004"	
			}] 	
		},
		{
			"componentUuid": "46bece19-cf6b-d721-d314-c794ead51657",
			"componentCode": "CP_RADIO",
			"componentSelectedItem": [{
				"selectedItemId": "S963",
				"selectedItemNm": "Seoul"		
			}] 	
		}
	]
}

Date component

Request examples

COMPONET BODY

[Date (single)] component (CP_DATE)
[Date (range)] component (CP_RANGE_DATE)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a date component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_DATE",
			"componentDateValue": {
				"day": "2022.09.08",
				"startDay": "",
				"endDay": ""
			}
		},
		{
			"componentUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
			"componentCode": "CP_RANGE_DATE",
			"componentDateValue": {
				"day": "",
				"startDay": "2022.09.08",
				"endDay": "2022.09.10"
			} 	
		}
	]
}

Time component

Request examples

COMPONET BODY

[Time (single)] component (CP_TIME)
[Time (range)] component (CP_RANGE_TIME)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a time component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_TIME",
			"componentTimeValue": {
				"time": "09:00",
				"startTime": "",
				"endTime": ""
			} 	
		},
		{
			"componentUuid": "0389d2b6-9eb2-21fc-04f7-2538fc36e950",
			"componentCode": "CP_RANGE_TIME",
			"componentTimeValue": {
				"time": "",
				"startTime": "09:00",
				"endTime": "18:00"
			} 	
		}
	]
}

Address component

Request examples

COMPONET BODY

[Address] component (CP_ADDR_KR)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes an address component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_ADDR_KR",
			"componentAddrValue": {
				"krPost": "13561",
				"krAddr1": "95 Jeongjail-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
				"krAddr2": "NAVER 1784"
			} 	
		}
	]
}

Request examples

COMPONET BODY

[Related document] component (WCP_WP_DOC)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a related document component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "WCP_WP_DOC",
			"componentRelDoc": [
                {
                  "aprvDocId": "2575",
                  "docType": "NM"
                },
                {
                  "aprvDocId": "41804",
                  "docType": "NM"
                }
            ]
		}
	]
}

Search employees component

Request examples

COMPONET BODY

[Search employees] component (WCP_SEARCH_EMP)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a search employees component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "WCP_SEARCH_EMP",
			"componentEmp": [
                {
                  "empId": "96b02530-82de-41c8-8223-3055c74e705e"
                },
                {
                  "empId": "d4db3880-b4e8-4efa-9698-25e8a900f08a"
                }
            ]
		}
	]
}

Search department component

Request examples

COMPONET BODY

[Search department] component (WCP_SEARCH_DEPT)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a search department component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "WCP_SEARCH_DEPT",
			"componentDeptValue": {
                "all": false,
                "deptList": [
                  {
                    "deptNo": "cgv202101000006"
                  },
                  {
                    "deptNo": "cgv202110000034"
                  }
               ]
            }
		}
	]
}

Currency component

Request examples

COMPONET BODY

[Currency] component (CP_CURRENCY)

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc

POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/7ba9b979-024f-4b09-8551-4e638dde0bae/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{	
	"title": "Proposes a currency component document.",
	"dfmId": "b81636c5-6254-433f-860b-6bf3df774180",	
	"trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"trgtUserId": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
	"trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
	"aprvLineMngYn": "Y",
	"shreUsersMngYn": "Y",
    "proxyYn": "N",
	"dataList":[
		{
			"componentUuid": "7161a6cc-ea4a-4408-e682-d777406059ea",
			"componentCode": "CP_CURRENCY",
			"componentCurrencyValue": {
                "code": "KRW",
                "value": 100
            }
		}
	]
}

Was this article helpful?

What's Next

Import-based document drafter v2

Table of contents

Description
Approval line
Shared recipient
Basic components
Table component
Formula table component
File attachment component
Image attachment component
Item component
Date component
Time component
Address component
Related document component
Search employees component
Search department component
Currency component

Create document using form generator v2 example

Description

Approval line

Request example 1

Request example 2

Shared recipient

Request example 1

Request example 2

Basic components

Request examples

Table component

Request examples

Formula table component

Request examples

File attachment component

Request examples

Image attachment component

Request examples

Item component

Request examples

Date component

Request examples

Time component

Request examples

Address component

Request examples

Related document component

Request examples

Search employees component

Request examples

Search department component

Request examples

Currency component

Request examples

What's Next