Creating a transfer document v2
  • PDF

Creating a transfer document v2

  • PDF

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Description

The documentation of the client company is transferred and prepared.

Request URL

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


Request header

| | Header | Description |
| ------------------------ | ---------------------------------------- |
| x-ncp-apigw-timestamp | - Milliseconds of elapsed time from UTC at 00:00:00 on January 1, 1970
- Invalid request if there is more than 5 minutes time difference with the API Gateway server |
| x-ncp-iam-access-key | - [Naver Cloud Platform Portal] (https://www.ncloud.com) {target="_blank"} or Access Key ID issued by SubAccount |
| x-ncp-apigw-signature-v2 | - Signatures encrypted with a Secret Key that maps the Body to the Access Key ID in the above example
- HMAC encryption algorithm uses HmacSHA256

Request Path Parameters

Parameter Type Size Must-have Description
companyId String 36 Y Integration key ```Developers > Preferences > Integration key`

Request Body Parameter

Parameter Type Size Must-have Description
docNo String 100 Y Document Number
dfmNm String 100 Y Format name
docTitle String 1000 Y Title
trgtUserNm String 1000 Y Applicant
drftYmd String 8 Y Application date (YYYYMMDD)
pdfFileId String 36 N Body PDF Attachment ID
registExternalKey String 36 Y Register ID - External Key
- Required either Workplace Employee ID or External Key or Login ID
registUserId String 36 Y Registrar workplace ID
- Required either workplace employee ID or external key or login ID
registLoginId String 36 Y Register Login ID
- Required either Workplace Employee ID or External Key or Login ID
fileIdList List N Attachment ID
aprvLineList List N Payment line information
- Payment line detailed link
shreTargetTpCd String 20 N Shared target (not shared if no share information is entered).)
- user: Share some targets
-comp: Share all targets
shreTargetList List N ShreTargetInformation
- ShreTargetList

Payment line details

Parameters Type Size Must-have Description
aprvOrd int Y Payment order (orderly written from 1)
aprvUserNm String 1000 Y Payment name
aprvDt String 20 Y Payment date and time (YYYY-MM-DD HH:MM:SS)

Shareholder details

Parameters Type Size Must-have Description
shreUserCompanyId String 36 Y Shared to (user): Shared Company ID
shreExternalKey String 36 Y SharedTo(user): Shared external key
- Required either workplace employee ID or external key or login ID
shreUserId String 36 Y Shared to: Shared WorkplaceID
- Required either Workplace Employee ID or External Key or Login ID
shreLoginId String 36 Y Shared to: Shared Login ID
- Required either Workplace Employee ID or External Key or Login ID
shreCompanyId String 36 Y Shared target (comp):Shared company ID (valid company ID)

Request example

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

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


Response

It is returned to the HTTP status code and delivered as body information.

HTTP Status Code Response Message Description
200 OK General Request Success
201 Created Response Code to Resource Creation Success
400 Bad Request Used for Common Request Failures
500 Internal Server Error - Response code for common server errors
- 4XX error codes are used to indicate client-side errors
- 5XX error codes are used to indicate server-side errors

Response example

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

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



Was this article helpful?

What's Next