View details of document form generator v2

Article Summary

Share feedback

Thanks for sharing your feedback!

This is the API to search details of a document from the form generator.

View API

It searches the details of a document from the form generator.

Request URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/doc/{aprvDocId}

Common request header

Header	Description
x-ncp-apigw-timestamp	Indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds, and if the time difference compared to the API Gateway server is 5 minutes or more, then the request is considered invalid
x-ncp-iam-access-key	Access key ID issued on the NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	A signature encrypted with the access key ID value and the secret key. HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Size	Requirement status	Description
companyId	String	36	Y	Integration key (CompanyId)`Developers basic settings integration key`
aprvDocId	String	36	Y	Integration key (AprvDocId)`Search target document ID`

Request examples

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/doc/39283

GET /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/doc/39283
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=

Response data

Parameter	Type	Capacity	Requirement Status	Description
tenantId	String	36	Y	Tenant ID
companyId	String	36	Y	Company ID
aprvDocId	String	20	Y	Approval document ID
dfmId	String	36	Y	Form code
doc	Json	1024	Y	Document's common information JSON
shre	Json	1024	Y	Document's sharing settings information JSON
shreOpnion	Json	1024	Y	Document's shared opinion information JSON
aprvLine	Json	1024	Y	Document's approval line information JSON
rcpt	Json	1024	Y	Document's recipient information JSON
attachFile	Json	1024	Y	Document's attachment information JSON
relatedDoc	Json	1024	Y	Document's common information JSON
docBody	Json	1024	Y	Document's body information JSON

Detailed response data

Parameter	Details	Type	Capacity	Requirement Status	Description
tenantId		String	36	Y	Tenant ID
companyId		String	36	Y	Company ID
aprvDocId		String	20	Y	Approval document ID
dfmId		String	36	Y	Form code
doc		Json		Y	Document's common information JSON
	tenantId	String	36	Y	Tenant ID
	companyId	String	36	Y	Company ID
	companyNm	String	150	Y	Document company name (default language)
	companyI18nNames	Map		N	Document company name (list of multiple languages)
	aprvDocId	String	20	Y	Approval document ID
	categoryId	String	36	Y	Category ID
	categoryNm	String	150	Y	Category name (default language)
	categoryI18nNames	Map		N	Category name (list of multiple languages)
	dfmId	String	36	Y	Form code
	dfmNm	String	150	Y	Form name (default language)
	dfmI18nNames	Map		N	Form name (list of multiple languages)
	dfmVersion	String	9	Y	Form version
	docTitle	String	1000	Y	Document title
	docNo	String	36	Y	Document number
	docStatCd	String	36	Y	Document status code
	docStatNm	String	150	Y	Document status name (default language)
	docStatI18nNames	Map		N	Document status name (list of multiple languages)
	drftTzCd	String	100	N	Document application Zone ID
	drftYmdhmsDt	String	100	Y	Proposal date and time
	cmpltYmdhmsDt	String	100	N	Completion date and time
	trgtCompanyId	String	36	Y	Applicant company ID
	trgtCompanyNm	String	150	Y	Applicant company name (default language)
	trgtCompanyI18nNames	Map		N	Applicant company name (list of multiple languages)
	trgtExternalKey	String	36	Y	Applicant ID - External key (if the applicant is not deleted)
	trgtUserId	String	36	Y	Applicant ID
	trgtLoginId	String	500	Y	Applicant login ID (if the applicant is not deleted)
	trgtUserNm	String	150	Y	Applicant name (default language)
	trgtUserI18nNames	Map		N	Applicant name (list of multiple languages)
	trgtDeptCd	String	50	Y	Applicant department code
	trgtDeptNm	String	150	Y	Applicant department name
	trgtDeptI18nNames	Map		N	Applicant department name (list of multiple languages)
	trgtJobCd	String	150	Y	Applicant position code
	trgtJobNm	String	150	Y	Applicant position name
	trgtJobI18nNames	Map		N	Applicant position name (list of multiple languages)
	trgtPositCd	String	150	Y	Applicant job grade code
	trgtPositNm	String	150	Y	Applicant job grade name
	trgtPositI18nNames	Map		N	Applicant job grade name (list of multiple languages)
	trgtUserStatCd	String	50	Y	Applicant status code
	trgtUserStatNm	String	150	Y	Applicant status name (default language)
	trgtUserStatI18nNames	Map		N	Applicant status name (list of multiple languages)
	proxyYn	String	1	Y	"Proxy application status (If Y, then the creator is not the applicant.)"
	drftCompanyId	String	36	Y	Creator company ID
	drftCompanyNm	String	150	Y	Creator company name (default language)
	drftCompanyI18nNames	Map		N	Creator company name (list of multiple languages)
	drftExternalKey	String	36	Y	Creator ID - External key (if the creator is not deleted)
	drftUserId	String	36	Y	Creator ID
	drftLoginId	String	500	Y	Creator login ID (if the creator is not deleted)
	drftUserNm	String	150	Y	Creator name (default language)
	drftUserI18nNames	Map		N	Creator name (list of multiple languages)
	drftDeptCd	String	50	Y	Creator department code
	drftDeptNm	String	150	Y	Creator department name
	drftDeptI18nNames	Map		N	Creator department name (list of multiple languages)
	drftJobCd	String	150	Y	Creator position code
	drftJobNm	String	150	Y	Creator position name
	drftJobI18nNames	Map		N	Creator position name (list of multiple languages)
	drftPositCd	String	150	Y	Creator job grade code
	drftPositNm	String	150	Y	Creator job grade name
	drftPositI18nNames	Map		N	Creator job grade name (list of multiple languages)
	drftUserStatCd	String	150	Y	Creator status code
	drftUserStatNm	String	150	Y	Creator status name (default language)
	drftUserStatI18nNames	Map		N	Creator status name (list of multiple languages)
	delYn	String	1	Y	Hidden document status
shre		Json		Y	Document's sharing settings information JSON
	shreUsersList	List		N	Sharing target list (Link to detailed items)
shreOpnion		Json		Y	Document's shared opinion information JSON
	shreOpnionList	List		N	Shared opinion list (Link to detailed items)
aprvLine		Json		Y	Document's approval line information JSON
	aprvLineList	List		Y	Approval line list (Link to detailed items)
rcpt		Json		Y	Document's recipient information JSON
	rcptList	List		Y	Recipient list (Link to detailed items)
attachFile		Json		Y	Document's attachment information JSON (except forms created by Create Form)
	attachFileList	List		N	Attachment list (Link to detailed items)
relatedDoc		Json		Y	Document's related document information JSON (except forms created by Create Form)
	relatedDocList	List		N	Related document list (Link to detailed items)
docBody		Json		Y	Document's body information JSON
	docBodyList	List		N	Body information list (Link to detailed items)

List of sharing targets

Parameter	Type	Capacity	Requirement Status	Description
shreObjectTpCd	String	50	Y	Sharing target type code (user/comp)
shreObjectTpNm	String	150	Y	Type code name to be shared (default language)
shreObjectTpI18nNames	Map		N	Type code name to be shared (list of multiple languages)
shreExternalKey	String	36	N	Sharing target ID - External key (if the sharing target is an employee, if the target is not deleted)
shreObjectLoginId	String	500	Y	Sharing target login ID - External key (if the sharing target is an employee, if the target is not deleted)
shreObjectId	String	36	Y	Sharing target ID
shreObjectNm	String	150	Y	Sharing target name (default language)
shreObjectI18nNames	Map		N	Sharing target name (list of multiple languages)
shreDeptCd	String	50	Y	Department code of a person to share with (if the sharing target is an employee)
shreDeptNm	String	150	Y	Department name of a person to share with (if the sharing target is an employee)
shreDeptI18nNames	Map		N	Department name of a person to share with (list of multiple languages) (if the sharing target is an employee)
shreJobCd	String	150	Y	Position code of a person to share with (if the sharing target is an employee)
shreJobNm	String	150	Y	Position name of a person to share with (if the sharing target is an employee)
shreJobI18nNames	Map		N	Position name of a person to share with (list of multiple languages) (if the sharing target is an employee)
shrePositCd	String	150	Y	Job grade code of a person to share with (if the sharing target is an employee)
shrePositNm	String	150	Y	Job grade name of a person to share with (if the sharing target is an employee)
shrePositI18nNames	Map		N	Job grade name of a person to share with (list of multiple languages) (if the sharing target is an employee)
shreUserStatCd	String	150	Y	Status code of a person to share with (if the sharing target is an employee)
shreUserStatNm	String	150	Y	Status name of a person to share with (default language) (if the sharing target is an employee)
shreUserStatI18nNames	Map		N	Status name of a person to share with (list of multiple languages) (if the sharing target is an employee)

List of shared comments

Parameter	Type	Size	Requirement status	Description
shreOpnionSeq	int		Y	Order of shared comments
shreOpnionCompanyId	String	36	Y	Company ID of a person to share with
shreOpnionCompanyNm	String	150	Y	Company name of a person to share with (default language)
shreOpnionCompanyI18nNames	Map		N	Company name of a person to share with (list of multiple languages)
shreOpnionExternalKey	String	36	Y	ID of a person to share with - External key (if the person is not deleted)
shreOpnionUserId	String	36	Y	ID of a person to share with
shreOpnionLoginId	String	500	Y	Login ID of a person to share with (if the person is not deleted)
shreOpnionUserNm	String	150	Y	Name of a person to share with (default language)
shreOpnionUserI18nNames	Map		N	Name of a person to share with (list of multiple languages)
shreOpnionDeptNm	String	150	Y	Department name of a person to share with
shreOpnionDeptI18nNames	Map		N	Department name of a person to share with (list of multiple languages)
shreOpnionJobNm	String	150	Y	Position name of a person to share with
shreOpnionJobI18nNames	Map		N	Position name of a person to share with (list of multiple languages)
shreOpnionPositNm	String	150	Y	Job grade name of a person to share with
shreOpnionPositI18nNames	Map		N	Job grade name of a person to share with (list of multiple languages)
shreOpnionUserStatCd	String	50	Y	Status code of a person to share with
shreOpnionUserStatNm	String	150	Y	Status name of a person to share with (default language)
shreOpnionUserStatI18nNames	Map		N	Status name of a person to share with (list of multiple languages)
shreOpnionCont	String	150	Y	Shared comments
shreOpnionYmdhmsDt	String	100	Y	Date and time of entering shared comments

List of approval lines

Parameter	Type	Size	Requirement status	Description
aprvOrd	int		Y	Approval order
aprvParallelGrp	int		Y	Approval parallel group (same value for same group)
aprvParallelDtlGrp	int		Y	Sequential group within the approval parallel group
aprvParallelDtlOrd	int		Y	Sequential order within the approval parallel group
aprvCompanyId	String	36	Y	Approver company ID
aprvCompanyNm	String	150	Y	Approver company name (default language)
aprvCompanyI18nNames	Map		N	Approver company name (list of multiple languages)
aprvExternalKey	String	36	Y	Approver ID - External key (if the approver is not deleted)
aprvUserId	String	36	Y	Approver ID
aprvLoginId	String	500	Y	Approver login ID (if the approver is not deleted)
aprvUserNm	String	150	Y	Approver name (default language)
aprvUserI18nNames	Map		N	Approver name (list of multiple languages)
aprvDeptExternalKey	String	50	Y	Approver department code - External key (if the approver is not deleted)
aprvDeptCd	String	50	Y	Approver department code
aprvDeptNm	String	150	Y	Approver department name
aprvDeptI18nNames	Map		N	Approver department name (list of multiple languages)
aprvJobCd	String	150	Y	Approver position code
aprvJobNm	String	150	Y	Approver position name
aprvJobI18nNames	Map		N	Approver position name (list of multiple languages)
aprvPositCd	String	150	Y	Approver job grade code
aprvPositNm	String	150	Y	Approver job grade name
aprvPositI18nNames	Map		N	Approver job grade name (list of multiple languages)
aprvUserStatCd	String	150	Y	Approver status code
aprvUserStatNm	String	150	Y	Approver status name (default language)
aprvUserStatI18nNames	Map		N	Approver status name (list of multiple languages)
aprvStatCd	String	150	Y	Approval status code
aprvStatNm	String	150	Y	Approval status name (default language)
aprvStatI18nNames	Map		N	Approval status name (list of multiple languages)
aprvTpCd	String	150	Y	Approval type code
aprvTpCdNm	String	150	Y	Approval type name (default language)
aprvTpCdI18nNames	Map		N	Approval type name (list of multiple languages)
aprvYmdhms	String	20	Y	Date and time of approval
aprvOpnin	String	150	N	Approval comment
defaultYn	String	1	Y	Default approval line status
postponeYn	String	1	N	Pending status

Recipient list

Parameter	Details	Type	Capacity	Requirement Status	Description
statusCd		String	150	Y	Recipient status
statusNm		String	150	Y	Company ID of a person to share with
rcptAprvDocId		String	20	N	Received document ID when creating a received document
rcptAprvDocNo		String	36	N	Receipt document number
rcptAprvDocDrftYmdhms		String	100	N	Receip document draft date and time
rcptAprvDocCmpltYmdhms		String	100	N	Receip document completion date and time
rcptTypeCd		String	150	Y	Recipient type (employee: EMP, department: DEPT)
gatewayRcptEmp		Json	1024	N	Recipient type employee (EMP) information
	empRcptExternalKey	String	36	N	Employee external key
	empRcptExternalKey	String	500	N	Employee login ID
	empRcptEmpId	String	36	N	Employee ID
	empRcptEmpNm	String	150	N	Employee Name
	empRcptEmpI18nNames	Map		N	Employee name (multilingual list)
	empRcptDeptExternalKey	String	50	N	Employee's department external key
	empRcptDeptCd	String	50	N	Employee's department code
	empRcptDeptNm	String	150	N	Department name of employee
	empRcptDeptI18nNames	Map		N	Employee's department name (multilingual list)
gatewayRcptDept		Json	1024	N	Recipient type department (DEPT) information
	deptRcptExternalKey	String	50	N	Department external key
	deptRcptDeptCd	String	50	N	Department Code
	deptRcptDeptNm	String	150	N	Department name
	deptRcptDeptI18nNames	Map		N	Department name (multilingual list)
	deptRcptIncludeSubDept	String	10	N	Whether to include subdepartments
	inChargeUserExternalKey	String	50	N	External key of person in charge
	inChargeUserLoginId	String	500	N	Login ID of person in charge
	inChargeUserId	String	36	N	ID of person in charge
	inChargeUserNm	String	150	N	Name of person in charge
	inChargeUserI18nNames	Map		N	Name of person in charge (multilingual list)

List of attachments

Parameter	Type	Capacity	Requirement Status	Description
attachSeq	int		Y	File order
attachFileNm	String	150	Y	File name
attachFileSize	int		Y	File size

List of related documents

Parameter	Type	Size	Requirement status	Description
relAprvSeq	int		Y	Order of related documents
relAprvDocId	String	20	Y	Related document ID
relAprvDocNo	String	36	Y	Related document number

List of body information

Parameter	Type	Size	Requirement status	Description
componentCode	String	1024	Y	Component code
componentName	String	1024	Y	Component name
componentUuid	String	1024	Y	Component UUID
componentCustomId	String	1024	Y	Custom ID (This is the ID entered by the form generator. It is retained when the component is removed from the integration. )
orderNum	int	32	Y	Sort order
label	String	1024	Y	Component label
value	Json	1024	Y	JSON of value information registered by customer (link to detailed items)

Component details value

Text component (CP_TEXT)

Parameter	Type	Capacity	Requirement Status	Description
ver	int		Y	Version
value	String	1024	N	content

Smart Editor component (CP_EDITOR)

Parameter	Type	Capacity	Requirement Status	Description
ver	int		Y	Version
type	String	20	N	Type (HTML)
contents	String	1024	N	content

Automatically displayed text component (CP_HIDDEN_TEXT)

Parameter	Type	Capacity	Requirement Status	Description
ver	int		Y	Version
writeMtime	int		N	Creation time
prepareText	String	100	N	Admin settings value
empId	String	50	N	Creator ID
empNm	Map	100	N	Creator name (list of multiple languages)
deptNo	String	50	N	Creator department code
deptNm	Map	100	N	Creator department name (list of multiple languages)
email	String	100	N	Creator email
isShowEmpInfo	boolean		N	Display status of creator information
isShowWriteTime	boolean		N	Display status of creation time
isShowPrepareText	boolean		N	Display status of admin settings value
apiData	String	1024	N	Stored data when entered as API

Table component (CP_TABLE_FORM)

Parameter	Type	Capacity	Requirement Status	Description
ver	int		Y	Version
uuid	String	50	N	Table UUID
headers	List		Y	List of header information
uuid	> String	50	Y	Header column UUID
cellIndex	> int		Y	Header column index
cellType	> String	50	Y	Header column type
cellName	> Map		Y	Header column name (list of multiple languages)
rowdatas	List		Y	List of row information
rowIndex	> int		Y	Row index
cellDatas	> List		Y	List of row column information
uuid	>> String	50	N	Row column UUID
cellIndex	>> int		N	Row column index
cellType	>> String	50	Y	Row column type
value	>> String	1024	N	Row column value

Formula table component (CP_TABLE_FORM_CAL)

Parameter	Type	Capacity	Requirement Status	Description
ver	int		Y	Version
uuid	String	50	N	Table UUID
headers	List		Y	List of header information
uuid	> String	50	Y	Header column UUID
cellIndex	> int		Y	Header column index
cellType	> String	50	Y	Header column type
cellName	> Map		Y	Header column name (list of multiple languages)
isCalCol	> boolean		Y	Header column formula status
rowdatas	List		Y	List of row information
rowIndex	> int		Y	Row index
isSubTotalRow	> boolean		Y	Row subtotal status
cellDatas	> List		Y	List of row column information
uuid	>> String	50	N	Row column UUID
cellIndex	>> int		N	Row column index
cellType	>> String	50	Y	Row column type
value	>> String	1024	N	Row column value
isCalCol	>> boolean		Y	Row column formula status

Description of response code

Document status code

Code	Description
temp	Save draft
ing	In progress
cmplt	Completed
decline	Rejected
cancel	Canceled

Approval type

Code	Description
aprv	Approval
refer	Reference
agree	Agreement
parallelAprv	Parallel approval
parallelAgree	Parallel agreement

Approver employment status

Code	Description
STANDBY	Prospective employee
IN	Employed
REST	On leave of absence
RETIRE	Retired
DELETE	Deleted
TRANSFER	Transferred
UNKNOWN	Unknown
NONE	Deleted

Approval status

Code	Description
wait	To be approved
ing	Pending approval
cmplt	Approved
decline	Rejected
userDeleg	Delegated
mngrDeleg	Delegated by admin
autoDeleg	Automatically delegated (absence)
dupDeleg	Internal code
conclude	Arbitrary decision
concludeCmplt	Consent to arbitrary decision
precedingDecline	Rejected and sent back
notCmplt	Internal code

Recipient status

Code	Description
ORG_DOC_ING	The sent document is in progress.
RCPT_WAIT	Receipt Pending
RCPT_DONE	Receipt Submitted
RCPT_RETURN	Received and Returned
RCPT_DOC_ING	The received document is in progress.
RCPT_DOC_CMPLT	Received Document Completed
RCPT_DOC_RETURN	Received Document Rejected
RCPT_DOC_FORCE_CMPLT	Completed Upon Receipt Acceptance

Response examples

{
  "tenantId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
  "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
  "aprvDocId": "39283",
  "dfmId": "09161cb2-9516-46a7-bc16-fb1a4b0dbd52",
  "doc": {
    "tenantId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "companyNm": "[AA] test2",
    "companyI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "aprvDocId": "39283",
    "categoryId": "9561",
    "categoryNm": "For checking form data",
    "categoryI18nNames": {
      "ko_KR": "For checking form data",
      "en_US": "For checking form data",
      "ja_JP": "For checking form data",
      "zh_CN": "For checking form data",
      "zh_TW": ""
    },
    "dfmId": "09161cb2-9516-46a7-bc16-fb1a4b0dbd52",
    "dfmNm": "Form sample",
    "dfmI18nNames": {
      "ko_KR": "Form sample",
      "en_US": "Form sample",
      "ja_JP": "Form sample",
      "zh_CN": "Form sample",
      "zh_TW": ""
    },
    "dfmVersion": "2",
    "docTitle": "Form sample title",
    "docNo": "2021-CUS00465-000002",
    "docStatCd": "ing",
    "docStatNm": "Progress",
    "docStatI18nNames": {
      "ko_KR": "Progress",
      "en_US": "In Progress",
      "ja_JP": "承認中",
      "zh_CN": "进行",
      "zh_TW": ""
    },
    "drftTzCd": "Pacific/Midway",
    "drftYmdhmsDt": "2021-12-02T15:03:52+09:00[Asia/Seoul]",
    "cmpltYmdhmsDt": null,
    "trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "trgtCompanyNm": "[AA] test2",
    "trgtCompanyI18nNames": {
      "ko_KR": "[AA] test2",
      "en_US": "[AA] test2",
      "ja_JP": "[AA] test2",
      "zh_CN": "[AA] test2",
      "zh_TW": ""
    },
    "trgtExternalKey": null,
    "trgtUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "trgtLoginId": null,
    "trgtUserNm": "(AA) Admin",
    "trgtUserI18nNames": {
      "ko_KR": "(AA) Admin",
      "en_US": "(AA) Manager",
      "ja_JP": "(AA) Admin",
      "zh_CN": "(AA) Admin",
      "zh_TW": ""
    },
    "trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "trgtDeptNm": "test",
    "trgtDeptI18nNames": {
      "ko_KR": "test",
      "en_US": "Hello test",
      "ja_JP": "Hello test",
      "zh_CN": "Hello test",
      "zh_TW": ""
    },
    "trgtJobCd": null,
    "trgtJobNm": "",
    "trgtJobI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "trgtPositCd": null,
    "trgtPositNm": "",
    "trgtPositI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "trgtUserStatCd": "IN",
    "trgtUserStatNm": "Employment",
    "trgtUserStatI18nNames": {
      "zh_TW": "在職",
      "ko_KR": "Employed",
      "en_US": "Work",
      "zh_CN": "在职",
      "ja_JP": "在職"
    },
    "proxyYn": "N",
    "drftCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "drftCompanyNm": "[AA] test2",
    "drftCompanyI18nNames": {
      "ko_KR": "[AA] test2",
      "en_US": "[AA] test2",
      "ja_JP": "[AA] test2",
      "zh_CN": "[AA] test2",
      "zh_TW": ""
    },
    "drftExternalKey": null,
    "drftUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "drftLoginId": null,
    "drftUserNm": "(AA) Admin",
    "drftUserI18nNames": {
      "ko_KR": "(AA) Admin",
      "en_US": "(AA) Manager",
      "ja_JP": "(AA) Admin",
      "zh_CN": "(AA) Admin",
      "zh_TW": ""
    },
    "drftDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "drftDeptNm": "test",
    "drftDeptI18nNames": {
      "ko_KR": "test",
      "en_US": "Hello test",
      "ja_JP": "Hello test",
      "zh_CN": "Hello test",
      "zh_TW": ""
    },
    "drftJobCd": null,
    "drftJobNm": "",
    "drftJobI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "drftPositCd": null,
    "drftPositNm": "",
    "drftPositI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "drftUserStatCd": "IN",
    "drftUserStatNm": "Employment",
    "drftUserStatI18nNames": {
      "zh_TW": "在職",
      "ko_KR": "Employed",
      "en_US": "Work",
      "zh_CN": "在职",
      "ja_JP": "在職"
    },
    "delYn": "N"
  },
  "shre": [
    {
      "shreObjectTpCd": "user",
      "shreObjectTpNm": "User",
      "shreObjectTpI18nNames": {
        "ko_KR": "User",
        "en_US": "User",
        "ja_JP": "使用者",
        "zh_CN": "用户",
        "zh_TW": ""
      },
      "shreExternalKey": null,
      "shreObjectLoginId": null,
      "shreObjectId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "shreObjectNm": "Jane Doe",
      "shreObjectI18nNames": {
        "ko_KR": "Jane Doe",
        "en_US": "Jane Doe",
        "ja_JP": "Jane Doe",
        "zh_CN": "Jane Doe",
        "zh_TW": ""
      },
      "shreDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "shreDeptNm": "test",
      "shreDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "shreJobCd": null,
      "shreJobNm": "",
      "shreJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shrePositCd": null,
      "shrePositNm": "",
      "shrePositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreUserStatCd": "IN",
      "shreUserStatNm": "Employment",
      "shreUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "Employed",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    {
      "shreObjectTpCd": "user",
      "shreObjectTpNm": "User",
      "shreObjectTpI18nNames": {
        "ko_KR": "User",
        "en_US": "User",
        "ja_JP": "使用者",
        "zh_CN": "用户",
        "zh_TW": ""
      },
      "shreExternalKey": null,
      "shreObjectLoginId": null,
      "shreObjectId": "70cba748-40f8-4a02-9cd6-9510c044022d",
      "shreObjectNm": "Gildong Hong",
      "shreObjectI18nNames": {
        "ko_KR": "John Doe",
        "en_US": "Gildong Hong",
        "ja_JP": "Gildong Hong",
        "zh_CN": "Gildong Hong",
        "zh_TW": ""
      },
      "shreDeptCd": "test2008000665",
      "shreDeptNm": "Accounting group",
      "shreDeptI18nNames": {
        "ko_KR": "Accounting group",
        "en_US": "Accounting group",
        "ja_JP": "Accounting group",
        "zh_CN": "Accounting group",
        "zh_TW": ""
      },
      "shreJobCd": null,
      "shreJobNm": "",
      "shreJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shrePositCd": null,
      "shrePositNm": "",
      "shrePositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreUserStatCd": "IN",
      "shreUserStatNm": "Employment",
      "shreUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "Employed",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    }
  ],
  "shreOpnion": [
    {
      "shreOpnionSeq": 1,
      "shreOpnionCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "shreOpnionCompanyNm": "[AA] test2",
      "shreOpnionCompanyI18nNames": {
        "ko_KR": "[AA] test2",
        "en_US": "[AA] test2",
        "ja_JP": "[AA] test2",
        "zh_CN": "[AA] test2",
        "zh_TW": ""
      },
      "shreOpnionExternalKey": null,
      "shreOpnionUserId": "96b02530-82de-41c8-8223-3055c74e705e",
      "shreOpnionLoginId": null,
      "shreOpnionUserNm": "(AA) Admin",
      "shreOpnionUserI18nNames": {
        "ko_KR": "(AA) Admin",
        "en_US": "(AA) Manager",
        "ja_JP": "(AA) Admin",
        "zh_CN": "(AA) Admin",
        "zh_TW": ""
      },
      "shreOpnionDeptNm": "test",
      "shreOpnionDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "shreOpnionJobNm": "",
      "shreOpnionJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreOpnionPositNm": "",
      "shreOpnionPositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreOpnionUserStatCd": "IN",
      "shreOpnionUserStatNm": "Employment",
      "shreOpnionUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "Employed",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      },
      "shreOpnionCont": "This is a shared comment.",
      "shreOpnionYmdhmsDt": "2021-12-15T18:55:08+09:00[Asia/Seoul]"
    }
  ],
  "aprvLine": [
    {
      "aprvOrd": 1,
      "aprvParallelGrp": 0,
      "aprvParallelDtlGrp": 0,
      "aprvParallelDtlOrd": 0,
      "aprvCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "aprvCompanyNm": "[AA] test2",
      "aprvCompanyI18nNames": {
        "ko_KR": "[AA] test2",
        "en_US": "[AA] test2",
        "ja_JP": "[AA] test2",
        "zh_CN": "[AA] test2",
        "zh_TW": ""
      },
      "aprvExternalKey": null,
      "aprvUserId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "aprvLoginId": null,
      "aprvUserNm": "Jane Doe",
      "aprvUserI18nNames": {
        "ko_KR": "Jane Doe",
        "en_US": "Jane Doe",
        "ja_JP": "Jane Doe",
        "zh_CN": "Jane Doe",
        "zh_TW": ""
      },
      "aprvDeptExternalKey": null,
      "aprvDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "aprvDeptNm": "test",
      "aprvDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "aprvJobCd": null,
      "aprvJobNm": "",
      "aprvJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "aprvPositCd": null,
      "aprvPositNm": "",
      "aprvPositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "aprvUserStatCd": "IN",
      "aprvUserStatNm": "Employed",
      "aprvUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "Employed",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      },
      "aprvStatCd": "ing",
      "aprvStatNm": "Progress",
      "aprvStatI18nNames": {
        "ko_KR": "Progress",
        "en_US": "Progress",
        "ja_JP": "実行",
        "zh_CN": "进行",
        "zh_TW": ""
      },
      "aprvTpCd": "aprv",
      "aprvTpNm": "Approval",
      "aprvTpCdI18nNames": {
        "ko_KR": "Approval",
        "en_US": "Approval",
        "ja_JP": "決裁",
        "zh_CN": "审批",
        "zh_TW": ""
      },
      "aprvYmdhms": null,
      "aprvOpnin": null,
      "defaultYn": "N",
      "postponeYn": "N"
    }
  ],
  "rcpt": [
  {
    "statusCd": "ORG_DOC_ING",
    "statusNm": "The sent document is in progress.",
    "rcptAprvDocId": 0,
    "rcptAprvDocNo": null,
    "rcptAprvDocDrftYmdhms": null,
    "rcptAprvDocCmpltYmdhms": null,
    "rcptTypeCd": "EMP",
    "gatewayRcptEmp": {
      "empRcptExternalKey": null,
      "empRcptLoginId": null,
      "empRcptEmpId": "7185653f-c8cd-43bc-b4f0-712e7e61bbf2",
      "empRcptEmpNm": "Korean",
      "empRcptEmpI18nNames": {
        "ko_KR": "Korean",
        "en_US": "korean",
        "ja_JP": "korean",
        "zh_CN": "korean",
        "zh_TW": "korean"
      },
      "empRcptDeptExternalKey": null,
      "empRcptDeptCd": "null",
      "empRcptDeptNm": "Service team",
      "empRcptDeptI18nNames": {
        "ko_KR": "Service team",
        "en_US": "Service Team",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    },
    "gatewayRcptDept": null
  },
  {
    "statusCd": "RCPT_WAIT",
    "statusNm": "Receipt Pending",
    "rcptAprvDocId": 0,
    "rcptAprvDocNo": null,
    "rcptAprvDocDrftYmdhms": null,
    "rcptAprvDocCmpltYmdhms": null,
    "rcptTypeCd": "DEPT",
    "gatewayRcptEmp": null,
    "gatewayRcptDept": {
      "deptRcptExternalKey": null,
      "deptRcptDeptCd": "cgv2008000661",
      "deptRcptDeptNm": "Developers Group",
      "deptRcptDeptI18nNames": {
        "ko_KR": "Developers Group",
        "en_US": "Developers Group",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "deptRcptIncludeSubDept": "Y",
      "inChargeUserExternalKey": null,
      "inChargeUserLoginId": null,
      "inChargeUserId": null,
      "inChargeUserNm": "",
      "inChargeUserI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    }
  },
  {
    "statusCd": "RCPT_DOC_CMPLT",
    "statusNm": "Received Document Completed",
    "rcptAprvDocId": 43227,
    "rcptAprvDocNo": "2022-RCV01-000043",
    "rcptAprvDocDrftYmdhms": "2022-11-09T18:09:05+09:00[Asia/Seoul]",
    "rcptAprvDocCmpltYmdhms": "2022-11-09T18:09:05+09:00[Asia/Seoul]",
    "rcptTypeCd": "DEPT",
    "gatewayRcptEmp": null,
    "gatewayRcptDept": {
      "deptRcptExternalKey": null,
      "deptRcptDeptCd": "mng202110000034",
      "deptRcptDeptNm": "Korea - Management room",
      "deptRcptDeptI18nNames": {
        "ko_KR": "Korea - Management room",
        "en_US": "Management room",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "deptRcptIncludeSubDept": "Y",
      "inChargeUserExternalKey": null,
      "inChargeUserLoginId": null,
      "inChargeUserId": "96b02530-82de-41c8-8223-3055c74e705e",
      "inChargeUserNm": "관리자",
      "inChargeUserI18nNames": {
        "ko_KR": "관리자",
        "en_US": "（Manager）管理員",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    }
  }
]
  "attachFile": [
    {
      "attachSeq": 1,
      "attachFileNm": "Screenshot 11-29-2021 PM 8.06.59.png",
      "attachFileSize": 184391
    }
  ],
  "relatedDoc": [
    {
      "relAprvSeq": 1,
      "relAprvDocId": "37768",
      "relAprvDocNo": "2021-TCP01-000038"
    }
  ],
  "docBody": [
    {
      "componentCode": "CP_TEXT",
      "componentName": "Text",
      "componentUuid": "71b76fd6-72d6-9994-7778-db119dab1993",
      "componentCustomId": "custom-uuid-001",
      "orderNum": 0,
      "label": "ID",
      "value": {
        "ver": 2,
        "value": "test_id"
      }
    }
  ]
}

Was this article helpful?

What's Next

Searching document details v1

Table of contents

View API