POST/business-support/approval/imported-documents

이관 문서를 작성한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

businessSupport.approval

HTTP Request

POSThttps://www.worksapis.com/v1.0/business-support/approval/imported-documents

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
documentNumber string 

문서 번호


required
minLength : 1
maxLength : 100 
documentFormName string 

서식명


required
minLength : 1
maxLength : 100 
title string 

제목


required
minLength : 1
maxLength : 200 
userName string 

작성자


required
minLength : 1
maxLength : 200 
createdDate string 

작성 일자(형식: YYYY-MM-DD)


required 
completedDate string 

완료 일자(형식: YYYY-MM-DD)


required 
pdfFileId string 

본문 PDF 파일 ID

 
fileIds array (string) 

첨부 파일 정보

 
approvalLines array (ImportedDocumentApprovalLine) 

결재선 정보

 
shareType string 

공유 설정 유형

  • PART_SHARE: 일부 공유
  • ALL_SHARE: 전체 공유
 
sharedMembers array (ImportedDocumentSharedMembers) 

공유자 정보

 

ImportedDocumentApprovalLine

PropertyTypeDescription
sequence integer 

결재선 순서

  • 결재 순서는 1부터 순차적으로 입력한다.

required 
userName string 

결재자


required
minLength : 1
maxLength : 200 
approvalTime string 

처리 일시(형식: YYYY-MM-DDThh:mm:ssTZD)


required 

ImportedDocumentSharedMembers

PropertyTypeDescription
type string 

공유자 유형

  • DOMAIN: 회사
  • USER: 구성원

required 
id string 

공유자 ID

  • 공유자 유형이 회사이면 도메인 ID를 입력한다.
  • 공유자 유형이 구성원이면 구성원 ID를 입력한다.

required 

Request Example

example

1{2  "documentNumber": "2024-TEST-00001",3  "documentFormName": "휴가신청서",4  "title": "2024.07.01 휴가 신청",5  "userName": "홍길동",6  "createdDate": "2024-07-01",7  "completedDate": "2024-07-10",8  "pdfFileId": "kr1.tmp.65d21127-a075-8040-72aa-5daa2748de79",9  "fileIds": [10    "kr1.tmp.f7cb1554-f925-b66c-ef7a-47295330b0a3"11  ],12  "approvalLines": [13    {14      "sequence": 1,15      "userName": "김대한",16      "approvalTime": "2024-07-10T15:10:05+09:00"17    }18  ],19  "shareType": "PART_SHARE",20  "sharedMembers": [21    {22      "type": "USER",23      "id": "56006105-ffe5-f258-c424-27c0bde4258c"24    }25  ]26}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

도메인 ID


required 
approvalDocumentId integer 

결재 문서 ID


required 
documentNumber string 

문서 번호


required 
documentFormName string 

서식명


required 
title string 

제목


required 
userName string 

작성자


required 
createdDate string 

작성 일자(형식: YYYY-MM-DD)


required 
completedDate string 

완료 일자(형식: YYYY-MM-DD)

 
pdfFileId string 

본문 PDF 파일 ID

 
fileIds array (string) 

첨부 파일 정보

 
approvalLines array (ImportedDocumentApprovalLine) 

결재선 정보

 
shareType string 

공유 설정 유형

 
sharedMembers array (ImportedDocumentShared) 

공유자 정보

 

ImportedDocumentApprovalLine

PropertyTypeDescription
sequence integer 

결재선 순서

  • 결재 순서는 1부터 순차적으로 입력한다.

required 
userName string 

결재자


required
minLength : 1
maxLength : 200 
approvalTime string 

처리 일시(형식: YYYY-MM-DDThh:mm:ssTZD)


required 

ImportedDocumentShared

PropertyTypeDescription
type string 

공유자 유형

  • DOMAIN: 회사
  • USER: 구성원

required 
id string 

공유자 ID

  • 공유자 유형이 회사이면 도메인 ID를 입력한다.
  • 공유자 유형이 구성원이면 구성원 ID를 입력한다.

required 
name string 

공유자

  • 공유자 유형이 회사이면 회사명을 전달한다.
  • 공유자 유형이 구성원이면 구성원 이름을 전달한다.
 

Response Example

example

1{2  "domainId": 10000001,3  "approvalDocumentId": 10001,4  "documentNumber": "2024-TEST-00001",5  "documentFormName": "휴가신청서",6  "title": "2024.07.01 휴가 신청",7  "userName": "홍길동",8  "createdDate": "2024-07-01",9  "completedDate": "2024-07-10",10  "pdfFileId": "kr1.10000001.65d21127-a075-8040-72aa-5daa2748de79",11  "fileIds": [12    "kr1.10000001.f7cb1554-f925-b66c-ef7a-47295330b0a3"13  ],14  "approvalLines": [15    {16      "sequence": 1,17      "userName": "김대한",18      "approvalTime": "2024-07-10T15:10:05+09:00"19    }20  ],21  "shareType": "PART_SHARE",22  "sharedMembers": [23    {24      "type": "USER",25      "id": "56006105-ffe5-f258-c424-27c0bde4258c",26      "name": "홍길동"27    }28  ]29}

HTTP 403

Forbidden