Approval API

Approval API로 결재 카테고리와 문서, 서식을 관리할 수 있다.

Approval API를 호출하려면 구성원 계정 또는 서비스 계정으로 인증하여 얻은 Access Token이 필요하다. API Scope는 businessSupport.approval, businessSupport.read이다.

결재 카테고리 관리 {#manage-approval-category}

다음 API로 결재 카테고리를 관리할 수 있다.

HTTP RequestDescription
POST /business-support/approval/categories결재 카테고리 생성
GET /business-support/approval/categories결재 카테고리 목록 조회
GET /business-support/approval/categories/{categoryId}결재 카테고리 조회
PATCH /business-support/approval/categories/{categoryId}결재 카테고리 부분 수정
DELETE /business-support/approval/categories/{categoryId}결재 카테고리 삭제

결재 카테고리는 순서를 설정할 수 있지만, Approval API로는 카테고리 이름('categoryName')과 다국어 이름(i18nNames)만 관리할 수 있다.

{    "categoryName": "일반",    "i18nNames": [{      "language": "en_US",      "name": "General"    },{      "language": "ko_KR",      "name": "일반"    },{      "language": "ja_JP",      "name": "一般"     }]}

결재 문서 관리 {#manage-approval-document}

다음 API로 결재 문서를 관리할 수 있다.

HTTP RequestDescription
POST /business-support/approval/users/{userId}/documents결재 문서 작성
POST /business-support/approval/imported-documents이관 문서 작성
POST /business-support/approval/users/{userId}/documents/create-document-link외부 문서 작성
GET /business-support/approval/documents/{approvalDocumentId}결재 문서 조회
GET /business-support/approval/users/{userId}/documents결재 문서 목록 조회 - 구성원
GET /business-support/approval/documents결재 문서 목록 조회 - 관리자

첨부 파일 관리 {#manage-approval-attachment}

다음 API로 결재 문서 첨부 파일을 관리할 수 있다.

HTTP RequestDescription
POST /business-support/approval/users/{userId}/documents/attachments첨부 파일 추가 - 회사 서식 기안용
POST /business-support/approval/imported-documents/attachments첨부 파일 추가 - 이관 문서

결재 서식 조회 {#read-approval-document-form}

다음 API로 결재 서식을 조회할 수 있다.

HTTP RequestDescription
GET /business-support/approval/document-forms결재 서식 목록 조회
GET /business-support/approval/document-forms/{documentFormId}결재 서식 조회

연동 코드 관리 {#manage-approval-linkage-codes}

다음 API로 연동 코드를 관리할 수 있다.

HTTP RequestDescription
POST /business-support/approval/linkage-codes연동 코드 생성
GET /business-support/approval/linkage-codes연동 코드 목록 조회
GET /business-support/approval/linkage-codes/{linkageCodeId}연동 코드 조회
PATCH /business-support/approval/linkage-codes/{linkageCodeId}연동 코드 부분 수정
POST /business-support/approval/linkage-codes/{linkageCodeId}/linkage-code-items연동 세부 코드 생성
GET /business-support/approval/linkage-codes연동 세부 코드 목록 조회
GET /business-support/approval/linkage-codes/{linkageCodeId}/linkage-code-items/{linkageCodeItemId}연동 세부 코드 조회
PATCH /business-support/approval/linkage-codes/{linkageCodeId}/linkage-code-items/{linkageCodeItemId}연동 세부 코드 부분 수정
DELETE /business-support/approval/linkage-codes/{linkageCodeId}/linkage-code-items/{linkageCodeItemId}연동 세부 코드 삭제