MENU
      get-data-box-frame-list
        • PDF

        get-data-box-frame-list

        • PDF

        기사 요약

        Data Box Frame의 목록을 조회합니다.

        GET https://{endpoint}/data-box-frame/get-data-box-frame-list
        HTTP

        요청

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        pageNoNoInteger1 ~ 100페이지 번호
        pageSizeNoInteger1 ~ 100페이지 당 조회되는 항목 수

        응답

        HTTP 상태코드설명
        200성공
        400요청 정보 오류
        401인증 실패
        403요청 정보에 대한 권한 없음
        404리소스가 존재하지 않음
        500서버 오류

        예시

        요청 예시

        GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-list
        HTTP

        응답 예시

        {
          "totalCount": 1,
          "content": [
            {
              "dataBoxFrameNo": "1046",
              "dataBoxFrameName": "frame-dev-20230315",
              "dataBoxCount": "1",
              "createDate": "2023-03-15 10:53:10",
              "statusCode": "SET_USE",
              "statusName": "Using"
            }
          ]
        }
        JSON

        속성

        항목필수 여부타입제약 사항설명
        totalCountYesIntegerData Box Frame의 총 수
        dataBoxFrameNoYesStringData Box Frame 번호
        dataBoxFrameNameYesStringData Box Frame 명
        dataBoxCountYesStringData Box Frame 내 Data Box의 수
        createDateYesStringData Box Frame 생성 일시
        statusCodeYesStringData Box Frame 상태 코드
        statusNameYesStringData Box Frame 상태 명

        오류 코드

        HTTP Status Code리턴 코드설명
        40010001,
        130***
        요청 정보 및 파라미터 오류
        40310002요청 정보에 대한 권한 없음
        40410009리소스가 존재하지 않음
        500130000서비스 내부 오류
        500139999연동 서비스 API 호출 오류

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

        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.