MENU
      get-data-box-list
        • PDF

        get-data-box-list

        • PDF

        Article summary

        It views the Data Box lists in Data Box Frame.

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

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        dataBoxFrameNoYesIntegerData Box Frame number
        pageNoNoInteger1 ~ 100Page number
        pageSizeNoInteger1 ~ 100Number of items viewed per page

        Responses

        HTTP status codeDescription
        200Success
        400Request information error
        401Authentication failed
        403No permission to request information
        404Resource not found
        500Server error

        Examples

        Request examples

        GET https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-list?dataBoxFrameNo=1046&pageNo=1&pageSize=10
        HTTP

        Response examples

        {
          "totalCount": 1,
          "content": [
            {
              "dataBoxNo": "194",
              "dataBoxName": "BOX#3",
              "memo": "",
              "createDate": "2023-04-04 16:24:37",
              "statusCode": "USE",
              "statusName": "Using"
            }
          ]
        }
        JSON

        Properties

        ItemsRequirement statusTypeRestrictionsDescription
        totalCountYesIntegerTotal number of Data Boxes
        dataBoxNoYesStringData Box number
        dataBoxNameYesStringData Box name
        createDateYesStringCreated date of Data Box
        statusCodeYesStringStatus code of Data Box
        statusNameYesStringStatus name of Data Box
        memoYesStringData Box memo
        disabledNoBooleanAccess availability of Data Box (for Sub Account)

        Errors

        HTTP Status CodeReturn codeDescription
        200-Successful normal request
        40010001,
        130***
        Request information and parameter error
        40310002No permission to request information
        40410009Resource not found
        500130000Service internal error
        500139999Integration service API call error

        Was this article helpful?

        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.