GET/business-support/approval/documents

결재 문서 목록을 조회한다.(관리자 전용)
작성일의 조회 조건은 최대 1개월이다.

Authorization

oauth2

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

Scope

businessSupport.approval
businessSupport.approval.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
fromDateTime string 

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


required
example : 2024-01-01 
untilDateTime string 

작성일 종료 일시(형식: YYYY-MM-DD)


required
example : 2024-01-20 
documentFormId string 

서식 코드

 
orderBy string 

정렬 방법. 정렬 항목과 순서를 공백(%20)으로 구분하여 입력한다.

  • 정렬 항목: createdTime, documentNumber
  • 순서: asc(오름차순), desc(내림차순)

example : createdTime%20desc 
count integer 

목록 조회 개수


default : 10
minimum : 10
maximum : 50
example : 10
format : int32 
cursor string 

다음 목록 조회 시 사용하는 값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
documents array (ApprovalDocument) 
 
responseMetaData object (responseMetaData) 

페이지 매김 처리를 위한 모델

 

ApprovalDocument

PropertyTypeDescription
domainId integer 

도메인 ID


required 
approvalDocumentId integer 

결재 문서 ID


required 
documentFormId string 

서식 코드


required 
categoryId integer 

카테고리 ID


required 
documentNumber string 

문서 번호

 
title string 

제목

 
userId string 

작성자 ID

 
userName string 

작성자

 
status string 

문서 상태

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

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


required 
completedTime string 

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

 
visible boolean 

문서 노출 여부

 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 페이지 조회를 위한 커서

 

Response Example

example

1{2  "documents": [3    {4      "domainId": 10000001,5      "approvalDocumentId": 10001,6      "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",7      "categoryId": 10,8      "documentNumber": "2024-CUS001-00001",9      "title": "연차 사용 계획서",10      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",11      "userName": "홍길동",12      "status": "APPROVED",13      "createdTime": "2024-01-01T10:00:00+09:00",14      "completedTime": "2024-01-02T11:30:00+09:00",15      "visible": true16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}