그룹 만들기

그룹을 만드는 API입니다.

API 만들기

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

API 만들기

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

API 요청

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

JSON 요청 형식입니다.

이름

유형

설명

필수 여부

action

문자열

작업 유형

GROUP_CREATE

groupId

문자열

그룹 아이디. 영어와 숫자와 ‘_’만 사용할 수 있습니다.

group01

name

문자열

그룹 이름

그룹 01

description

문자열

설명

아니오

매뉴얼웍스 그룹 01

그룹을 추가하는 예제입니다.

{
    "action": "GROUP_CREATE",
    "groupId": "group01",
    "name": "그룹 01",
    "description": "매뉴얼웍스 그룹 01"
}

API 응답

GROUP_CREATE 응답

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

GROUP_CREATE 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


예외 항목

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

예외

설명

GROUP_ID_CONFLICT

그룹 아이디가 이미 존재할 때

INVALID_GROUP_ID

그룹 아이디 형식이 맞지 않을 때

INVALID_PARAMETER

문자열의 길이 등이 형식에 맞지 않을 때

REQUIRED_PARAMETER_MISSING

API 요청에 필수 항목이 없을 때

예제

예제입니다.

{
	"status": "success"
}