사용자가 접근할 수 있는 프로젝트 목록을 반환하는 API입니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=PROJECT_LIST_BY_USER&userId=${userId}

URL 파라미터 항목입니다.

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	PROJECT_LIST_BY_USER
userId	문자열	사용자 아이디	예	user01

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=PROJECT_LIST_BY_USER&userId=user01

API 응답

`PROJECT_LIST_BY_USER` 응답

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

`PROJECT_LIST_BY_USER` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
projects	Project 객체 배열	프로젝트 목록. 설정에 따라 정렬합니다.	예

프로젝트가 없을 때는 projects로 빈 배열을 반환합니다.

`Project` 객체

`Project` 객체
이름	유형	설명	필수 여부	예
id	UUID	프로젝트 아이디	예	5b969d63e97cfec7
name	문자열	프로젝트 이름	예	ManualWorks V5
description	문자열	프로젝트 설명	아니오
children	Project 객체 배열	하위 프로젝트 목록. 하위 프로젝트가 없을 때는 속성이 존재하지 않습니다.	아니오

예외 항목

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

PROJECT_LIST_BY_USER 예외 항목
예외	설명
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_NOT_EXIST	사용자가 존재하지 않을 때

예제

예제입니다.

{
    "status": "success",
    "projects": [
		{
			"id": "b9c0451a065c571a",
	    	"name": "ManualWorks V5",
		    "description": "ManualWorks V5 프로젝트",
    		"children" : [
            	{
					"id": "6afc77612d5ad0fb",
					"name": "기술 문서"
				},
				{
					"id": "1007c2d173ad990d",
					"name": "영업 문서"
				}
			]
    	},
		{
			"id": "755a23e015006f95",
	    	"name": "ManualWorks V4 프로젝트"
		}
	]
}