그룹 목록 조회

권한을 가진 그룹 목록을 조회합니다.

API 계정 그룹의 권한에 따라 해당 그룹 및 하위 그룹의 정보만 조회 가능합니다.

그룹 목록 조회 (전체)

POST /rest/api/groups/list

Headers

Name	Type	Description
apikey*	String	발급된 api key

Request Body

Name	Type	Description
searchAll	boolean	권한이 있는 그룹 전체 조회 기본값 : false
idList*	Array	searchAll이 false 일 때, idList에 있는 그룹 정보만 조회

Request Example

요청 예시

{
    "searchAll":false,		// 권한이 있는 그룹의 전체 조회 옵션
    "idList":[
        {"groupId":1},	        // 특정 그룹 조회
        {"groupId":100}
    ]
}

Response Example

200: OK 성공 또는 핸들링된 오류

Example

{
    "message": "no permission groupId:100",	// 성공하지 못한 그룹
    "list": [
        {
            "groupId": 1,
            "groupName": "그룹명",
            "urlPath": "SGT_0000000001",
            "createDate": "2024-09-01T09:00:00",
            "groupAdminId": 1,
            "groupAdminLoginId": "[e-mail]",
            "linkedType": null,
            "level": 1,
            "parentGroupId": null,
            "used": true
        },
        ...
    ],
    "searchAll": false,
    "success": true
}

type

json

400: Bad Request 핸들링 하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/create-document"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}