GET/business-support/approval/documents/{approvalDocumentId}

결재 문서 상세 정보를 조회한다.

Authorization

oauth2

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

Scope

businessSupport.approval
businessSupport.approval.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/business-support/approval/documents/{approvalDocumentId}

Path Parameters

ParameterTypeDescription
approvalDocumentId string 

결재 문서 ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

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 

수신처 개수

 
recipients array (Recipient) 

수신처 정보

 
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 

공유자

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

Recipient

PropertyTypeDescription
status string 

수신 처리 상태

  • ORIGIN_IN_PROGRESS: 원본 진행
  • WAITING: 대기
  • ACCEPTED: 접수
  • RETURNED: 반송
  • IN_PROGRESS: 진행
  • COMPLETED: 완료
  • REJECTED: 반려
  • COMPLETED_AFTER_ACCEPT: 접수 후 완료

required 
draftedTime string 

수신 접수 일시(형식: YYYY-MM-DDThh:mm:ssTZD)

 
completedTime string 

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

 
type string 

수신처 유형

  • USER: 구성원
  • ORGUNIT: 조직

required 
orgUnitId string 

수신처 조직 ID

  • 수신처 유형이 USER이면 전달한다.
 
orgUnitName string 

수신처 조직명

  • 수신처 유형이 ORGUNIT이면 전달한다.
 
inChargeUserId string 

담당자 ID

  • 수신처 유형이 ORGUNIT이면 전달한다.
 
inChargeUserName string 

담당자명

  • 수신처 유형이 ORGUNIT이면 전달한다.
 
userId string 

구성원 ID

  • 수신처 유형이 USER이면 전달한다.
 
userName string 

구성원명

  • 수신처 유형이 USER이면 전달한다.
 

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": 2,51  "recipients": [52    {53      "status": "COMPLETED",54      "draftedTime": "2024-01-02T09:00:00+09:00",55      "completedTime": "2024-01-03T15:30:00+09:00",56      "type": "ORGUNIT",57      "orgUnitId": "7f2a9c31-b5d8-4e7a-9c12-4d6e8f1a2b3c",58      "orgUnitName": "경영지원팀",59      "inChargeUserId": "4b8c2d15-f6a7-4e39-b891-2c5d7e9f0a1b",60      "inChargeUserName": "최영호",61      "userId": "",62      "userName": ""63    },64    {65      "status": "WAITING",66      "draftedTime": "",67      "completedTime": "",68      "type": "USER",69      "orgUnitId": "",70      "orgUnitName": "",71      "inChargeUserId": "",72      "inChargeUserName": "",73      "userId": "3a6b1f22-e8c4-4d91-a72f-0e8b12d3f4a5",74      "userName": "이수진"75    }76  ],77  "documentBody": {}78}