Group 목록 조회
- 인쇄
- PDF
Group 목록 조회
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Group 목록을 조회합니다.
요청
- GET /groups
요청 파라미터
| 파라미터 | 필수여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| searchColumn | N | String | groupName, groupNrn, groupId | - 검색 컬럼 groupName, groupNrn, groupId |
| searchWord | N | String | 검색어 | |
| page | N | int | - 페이지 번호 기본값: 0 | |
| size | N | int | - 결과 목록 크기 기본값: 20 |
응답
응답 바디
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"groupId":"String",
"groupName":"String",
"nrn":"String",
"createdAt":"String",
"updatedAt":"String",
"description":"String"
}
],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| 파라미터 | 타입 | 설명 | 제약사항 |
|---|---|---|---|
| page | Number | page (required) 반환 받은 결과의 page | |
| totalPages | Number | totalPages (required) 반환 받은 결과의 totalPage | |
| totalItems | Number | totalItems (required) 반환 받은 결과의 totalItems | |
| hasPrevious | Boolean | hasPrevious (required) 현재 페이지 기준으로 이전 페이지 존재 여부 | |
| hasNext | Boolean | hasNext (required) 현재 페이지 기준으로 다음 페이지 존재 여부 | |
| isFirst | Boolean | isFirst (required) 전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부 | |
| isLast | Boolean | isLast (required) 전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부 | |
| items.[].groupId | String | 그룹 아이디 (UUID) | |
| items.[].groupName | String | 그룹 이름 | |
| items.[].nrn | String | 그룹 nrn | |
| items.[].description | String | 그룹 설명 | |
| items.[].createdAt | String | 생성 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | 수정 일시 (UTC, ex. 2023-04-25T13:11:50Z) |
에러
아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 ErrorResponse를 참고해 주십시오.
공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참조해 주십시오.
| HTTP status code | 에러 코드 | 에러 메시지 |
|---|---|---|
| 400 | 잘못된 요청 |
이 문서가 도움이 되었습니까?