Group 목록 조회
    • PDF

    Group 목록 조회

    • PDF

    기사 요약

    Group 목록을 조회합니다.

    요청

    • GET /groups

    요청 파라미터

    파라미터필수여부타입제약사항설명
    searchColumnNStringgroupName, groupNrn, groupId- 검색 컬럼
    groupName, groupNrn, groupId
    searchWordNString검색어
    pageNint- 페이지 번호
    기본값: 0
    sizeNint- 결과 목록 크기
    기본값: 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"
    }
    
    파라미터타입설명제약사항
    pageNumberpage (required) 반환 받은 결과의 page
    totalPagesNumbertotalPages (required) 반환 받은 결과의 totalPage
    totalItemsNumbertotalItems (required) 반환 받은 결과의 totalItems
    hasPreviousBooleanhasPrevious (required) 현재 페이지 기준으로 이전 페이지 존재 여부
    hasNextBooleanhasNext (required) 현재 페이지 기준으로 다음 페이지 존재 여부
    isFirstBooleanisFirst (required) 전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부
    isLastBooleanisLast (required) 전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부
    items.[].groupIdString그룹 아이디 (UUID)
    items.[].groupNameString그룹 이름
    items.[].nrnString그룹 nrn
    items.[].descriptionString그룹 설명
    items.[].createdAtString생성 일시 (UTC, ex. 2023-04-25T13:11:50Z)
    items.[].updatedAtString수정 일시 (UTC, ex. 2023-04-25T13:11:50Z)

    에러

    아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 ErrorResponse를 참고해 주십시오.
    공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참조해 주십시오.

    HTTP status code에러 코드에러 메시지
    400잘못된 요청

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.