그룹을 반환하는 API입니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=GROUP_GET&groupId=${groupId}

URL 파라미터 항목입니다.

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	GROUP_GET
groupId	문자열	그룹 아이디	예	group01

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=GROUP_GET&groupId=group01

API 응답

`GROUP_GET` 응답

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

`GROUP_GET` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
group	Group 객체	그룹 데이터	예

`Group` 객체

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

`Group` 객체
이름	유형	설명	필수 여부	예
id	UUID	UUID	예	5b969d63e97cfec7
groupId	문자열	그룹 아이디	예	group01
name	문자열	그룹 이름	예	그룹 01
description	문자열	설명	아니오	매뉴얼웍스 그룹 01
autoAssignment	boolean	새 사용자를 이 그룹에 자동으로 넣는지 여부	예	false

예외 항목

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

GROUP_GET 예외 항목
예외	설명
GROUP_NOT_EXIST	그룹이 존재하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제

예제입니다.

{
    "status": "success",
    "group": {
        "id": "5b969d63e97cfec7",
    	"groupId": "group01",
		"name": "그룹 01",
		"description": "매뉴얼웍스 그룹 01",
		"autoAssignment": false
    }
}