POST/business-support/approval/users/{userId}/documents

결재 문서를 작성한다.

주의

  • 회사 생성 서식으로만 결재 문서를 작성할 수 있다.(기본 제공 서식은 지원하지 않음)
  • 원소속 회사의 조직으로만 작성할 수 있으며, 결재선과 공유 설정은 관리자가 설정한 내용으로 작성된다.
  • 별도의 결재선 설정이 필요한 경우 결재선 정보를 요청 바디에 포함하여 전달한다.

주의

  • 결재선 정보의 결재자 ID를 설정시 원소속 부서의 구성원으로 일반 결재선이 생성된다.
  • 결재선 정보의 결재자 ID만 입력시 결재선 순서는 입력한 순서로, type은 APPROVAL로, status는 첫번째는 PENDING으로 다음부터 UPCOMING으로 고정된다.

Authorization

oauth2

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

Scope

businessSupport.approval

HTTP Request

POSThttps://www.worksapis.com/v1.0/business-support/approval/users/{userId}/documents

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
title string 

문서 제목


required
minLength : 1
maxLength : 200 
documentFormId string 

서식 코드


required 
documentBody array (DocumentBody) 

문서 작성 가이드(회사 생성 서식)를 참고한다.


required 
approvalLines array (ApprovalLine) 

userId(결재자 ID)는 다음과 같은 형태로 지정할 수 있다.
- 리소스 ID

 

DocumentBody

PropertyTypeDescription
componentType string 

컴포넌트 유형


required 
componentId string 

컴포넌트 ID(컴포넌트 ID 또는 사용자 지정 ID 입력 가능)


required 
componentValue object 

컴포넌트값

 

ApprovalLine

PropertyTypeDescription
sequence integer 

결재선 순서

 
type string 

결재선 유형

  • APPROVAL: 결재
  • REFERENCE: 참조
  • AGREEMENT: 합의
  • PARALLEL_APPROVAL: 병렬결재
  • PARALLEL_AGREEMENT: 병렬합의
 
status string 

결재 처리 상태

  • UPCOMING: 예정
  • PENDING: 대기
  • APPROVED: 승인
  • REJECTED: 반려
  • REJECTED_DESIGNATED: 지정 반려
  • REJECTED_PRECEDING: 이전 반려
  • REJECTED_AUTO: 자동 반려
  • DELEGATED_MANAGER: 관리자 위임
  • DELEGATED_USER: 사용자 위임
  • DELEGATED_AUTO: 자동 위임
  • DELEGATED_DUPLICATE: 중복 위임
  • FINAL_APPROVAL: 전결
  • FINAL_APPROVAL_CONSENT: 전결 동의
 
userId string 

결재자 ID

 
userName string 

결재자

 
orgUnitId string 

결재자 조직 ID

 
orgUnitName string 

결재자 조직명

 
approvalTime string 

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

 

Request Example

example

1{2  "title": "연차 사용 계획서",3  "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",4  "documentBody": [5    {6      "componentType": "CP_TEXT",7      "componentId": "f230ab03-59a3-0050-e7f5-3fd20d30d711",8      "componentValue": {9        "value": "홍길동"10      }11    }12  ],13  "approvalLines": [14    {15      "userId": "20754547-df5f-4aae-1494-030918f30e4d"16    },17    {18      "userId": "33384672-qf23-2aow-8746-865423r31q2r"19    }20  ]21}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

도메인 ID


required 
approvalDocumentId integer 

결재 문서 ID


required 
documentFormId string 

서식 코드


required 
categoryId integer 

카테고리 ID


required 
documentNumber string 

문서 번호

 
title string 

제목

 
status string 

문서상태

  • IN-PROGRESS: 진행
  • APPROVED: 완료(승인)
  • REJECTED: 반려
  • CANCELED: 취소

required 
userId string 

작성자 ID

 
userName string 

작성자

 
orgUnitId string 

작성자 조직 ID

 
orgUnitName string 

작성자 조직명

 
createdTime string 

작성 일시(형식: YYYY-MM-DDThh:mm:ssTZD)


required 
completedTime string 

완료 일시(형식: YYYY-MM-DDThh:mm:ssTZD)

 
visible boolean 

문서 노출 여부

 
viewUrl string 

문서 URL

 
approvalLines array (ApprovalLine) 

결재선 정보

 
shareType string 

공유 설정 유형

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

공유자 정보

 
opinionCount integer 

의견 개수

 
attachmentCount integer 

첨부 파일 개수

 
relatedDocumentCount integer 

연관 문서 개수

 
recipientCount integer 

수신처 개수

 
documentBody object 

문서 상세 정보 가이드(기본 제공 서식), (회사 생성 서식)를 참고한다.

 

ApprovalLine

PropertyTypeDescription
sequence integer 

결재선 순서

 
type string 

결재선 유형

  • APPROVAL: 결재
  • REFERENCE: 참조
  • AGREEMENT: 합의
  • PARALLEL_APPROVAL: 병렬결재
  • PARALLEL_AGREEMENT: 병렬합의
 
status string 

결재 처리 상태

  • UPCOMING: 예정
  • PENDING: 대기
  • APPROVED: 승인
  • REJECTED: 반려
  • REJECTED_DESIGNATED: 지정 반려
  • REJECTED_PRECEDING: 이전 반려
  • REJECTED_AUTO: 자동 반려
  • DELEGATED_MANAGER: 관리자 위임
  • DELEGATED_USER: 사용자 위임
  • DELEGATED_AUTO: 자동 위임
  • DELEGATED_DUPLICATE: 중복 위임
  • FINAL_APPROVAL: 전결
  • FINAL_APPROVAL_CONSENT: 전결 동의
 
userId string 

결재자 ID

 
userName string 

결재자

 
orgUnitId string 

결재자 조직 ID

 
orgUnitName string 

결재자 조직명

 
approvalTime string 

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

 

Shared

PropertyTypeDescription
type string 

공유자 유형

  • DOMAIN: 회사
  • USER: 구성원
  • ORGUNIT: 조직
  • ORGUNIT_INCLUDE_SUBS: 하위 포함 조직

required 
id string 

공유자 ID

  • 공유자 유형이 회사이면 도메인 ID를 전달한다.
  • 공유자 유형이 구성원이면 구성원 ID를 전달한다.
  • 공유자 유형이 부서 또는 하위 포함 부서이면 조직 ID를 전달한다.

required 
name string 

공유자

  • 공유자 유형이 회사이면 회사명을 전달한다.
  • 공유자 유형이 구성원이면 구성원 이름을 전달한다.
  • 공유자 유형이 부서 또는 하위 포함 부서이면 조직 이름을 전달한다.
 

Response Example

example

1{2  "domainId": 10000001,3  "approvalDocumentId": 10001,4  "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",5  "categoryId": 10,6  "documentNumber": "2024-CUS001-00001",7  "title": "연차 사용 계획서",8  "status": "IN-PROGRESS",9  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",10  "userName": "홍길동",11  "orgUnitId": "2c048949-e6d8-40ae-22a9-0374dd0b1976",12  "orgUnitName": "인사팀",13  "createdTime": "2024-01-01T10:00:00+09:00",14  "completedTime": "",15  "visible": true,16  "viewUrl": "https://flkow.worksmobile.com/user/view/doc/10001",17  "approvalLines": [18    {19      "sequence": 1,20      "type": "APPROVAL",21      "status": "PENDING",22      "userId": "20754547-df5f-4aae-1494-030918f30e4d",23      "userName": "김대한",24      "orgUnitId": "2c048949-e6d8-40ae-22a9-0374dd0b1976",25      "orgUnitName": "인사팀",26      "approvalTime": ""27    },28    {29      "sequence": 2,30      "type": "APPROVAL",31      "status": "UPCOMING",32      "userId": "1a29db81-cf2d-4b25-16fd-031ac869197d",33      "userName": "박총무",34      "orgUnitId": "2c048949-e6d8-40ae-22a9-0374dd0b1976",35      "orgUnitName": "총무팀",36      "approvalTime": ""37    }38  ],39  "shareType": "PART_SHARE",40  "sharedMembers": [41    {42      "type": "USER",43      "id": "56006105-ffe5-f258-c424-27c0bde4258c",44      "name": "김수연"45    }46  ],47  "opinionCount": 0,48  "attachmentCount": 0,49  "relatedDocumentCount": 0,50  "recipientCount": 0,51  "documentBody": {}52}

HTTP 403

Forbidden