진척 관리 항목 목록을 반환하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “EVENT” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 요청

GET 형식으로 요청해야 합니다.

요청 URL 형식입니다.

/r/api/${uuid}?action=DOC_TASK_LIST

URL 파라미터 항목입니다.

이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	8458cdd8b015ca04
action	문자열	작업 유형	예	DOC_TASK_LIST
docId	문자열	문서 아이디로 필터할 때	아니오	a162f15952712c06
type	문자열	유형으로 필터할 때	아니오	USER \| PROOFREADING \| CHANGE_REQUEST \| REVIEW_REQUEST
status	문자열	상태로 필터할 때	아니오	OPENED \| CLOSED \| REQUESTED \| APPROVED \| REJECTED

요청 URL 예제입니다.

/r/api/8458cdd8b015ca04?action=DOC_TASK_LIST&status=REQUESTED

API 응답

`DOC_TASK_LIST` 응답

JSON 형식의 응답은 다음과 같습니다.

`DOC_TASK_LIST` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
docTasks	DocTask 객체 배열	진척 관리 항목 목록. 설명으로 정렬합니다.	예

`DocTask` 객체

`DocTask` 객체
이름	유형	설명	필수 여부	예
id	UUID	라벨 아이디	예	54c0786ac3a51cd9
type	문자열	유형	예	USER \| PROOFREADING \| CHANGE_REQUEST \| REVIEW_REQUEST
status	문자열	상태	예	OPENED \| CLOSED \| REQUESTED \| APPROVED \| REJECTED
description	문자열	설명	예
document	Document 객체	문서	예
chapter	Chapter 객체	장	아니오
requestTime	long	요청 시간	아니오	상태가 REQUESTED일 때만 반환
requester	User 객체	상태가 REQUESTED일 때 승인 요청을 한 사용자	아니오	상태가 REQUESTED일 때만 반환
approver	User 객체	상태가 REQUESTED일 때 승인 요청을 받은 사용자	아니오

`Document` 객체

`Document` 객체
이름	유형	설명	필수 여부	예
id	UUID	UUID	예	5b969d63e97cfec7
type	문자열	문서 유형	예	BOOK
title	문자열	문서 제목	예	매뉴얼웍스 사용자 가이드

`Chapter` 객체

`Chapter` 객체
이름	유형	설명	필수 여부	예
id	UUID	UUID	예	e14d2a5674cc253d
type	문자열	장 유형	예	CHAPTER
title	문자열	장 제목	예	텍스트 에디터

`User` 객체

User 객체는 다음과 같습니다.

`User` 객체
이름	유형	설명	필수 여부	예
id	문자열	UUID	예	5b969d63e97cfec7
userId	문자열	사용자 아이디	예	user01
name	문자열	사용자 이름	예	사용자 01
email	문자열	이메일	예	support@3rabbitz.com

예외 항목

예외 항목은 다음과 같습니다.

예외	설명
INVALID_PARAMETER	검색 값이 유효하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제

예제입니다.

{
    "status": "success",
    "docTasks": [
		{
			"id": "b9c0451a065c571a",
	    	"type": "CHANGE_REQUEST",
	    	"status": "REQUESTED",
		    "description": "맞춤법 오류 수정 요청",
    		"document" : {
            	"id": "5b969d63e97cfec7",
				"type": "BOOK",
				"title": "매뉴얼웍스 사용자 가이드"
            },
    		"chapter" : {
            	"id": "e14d2a5674cc253d",
				"type": "CHAPTER",
				"title": "텍스트 에디터"
            },
            "requestTime": 1769567415184,
    		"requester" : {
            	"id": "5b969d63e97cfec7",
				"userId": "user01",
				"name": "사용자 1"
            },
    		"approver" : {
            	"id": "43bc63721537bf19",
				"userId": "user02",
				"name": "사용자 2"
            }
    	},
		{
			"id": "f931eef17e819b79",
	    	"type": "USER",
	    	"status": "OPENED",
		    "description": "매뉴얼웍스 6.0.14 릴리스",
    		"document" : {
            	"id": "5b969d63e97cfec7",
				"type": "BOOK",
				"title": "매뉴얼웍스 사용자 가이드"
            }
    	}
	]
}

API 만들기

API 요청

API 응답

DOC_TASK_LIST 응답

DocTask 객체

Document 객체

Chapter 객체