그룹 목록 가져오기

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

API 만들기

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

API 만들기

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

API 요청

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

요청 URL 형식입니다.

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

URL 파라미터 항목입니다.

이름

유형

설명

필수 여부

uuid

UUID

API UUID

5b969d63e97cfec7

action

문자열

작업 유형

GROUP_LIST

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=GROUP_LIST

API 응답

GROUP_LIST 응답

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

GROUP_LIST 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


groups

Group 객체 배열

그룹 데이터 목록.

  • 그룹 이름으로 정렬합니다.

  • 그룹이 없을 때는 빈 배열을 반환합니다.


Group 객체

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

Group 객체

이름

유형

설명

필수 여부

id

UUID

UUID

5b969d63e97cfec7

groupId

문자열

그룸 아이디

group01

name

문자열

그룹 이름

그룹 01

description

문자열

설명

아니오

매뉴얼웍스 그룹 01

예제

예제입니다.

{
    "status": "success",
    "groups": [
		{
        	"id": "5b969d63e97cfec7",
	    	"groupId": "group01",
			"name": "그룹 01",
			"description": "매뉴얼웍스 그룹 01"
    	},
		{
        	"id": "8b21548d77ffa750",
	    	"groupId": "group02",
			"name": "그룹 02",
			"description": "매뉴얼웍스 그룹 02"
    	}
	]
}