get-data-box-frame-detail
    • PDF

    get-data-box-frame-detail

    • PDF

    Article summary

    It views the details of the created Data Box Frame.

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

    Requests

    Request parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    dataBoxFrameNoNoIntegerData Box Frame number

    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-frame/get-data-box-frame-detail?dataBoxFrameNo=1046
    

    Response examples

    {
      "dataBoxFrameNo": "1046",
      "dataBoxFrameName": "frame-sample",
      "dataBoxCount": "1",
      "createDate": "2023-03-15 10:53:10",
      "statusCode": "SET_USE",
      "statusName": "Using",
      "memo": "memo sample",
      "exportBucketName": "011",
      "usePseudonymInfo": "Y"
    }
    

    Properties

    ItemsRequirement statusTypeRestrictionsDescription
    dataBoxFrameNoYesStringData Box Frame number
    dataBoxFrameNameYesStringData Box Frame name
    dataBoxCountYesStringNumber of Data Boxes in Data Box Frame
    createDateYesStringCreated date of Data Box Frame
    statusCodeYesStringStatus code of Data Box Frame
    statusNameYesStringStatus name of Data Box Frame
    memoNoStringData Box Frame memo
    exportBucketNameYesStringName of Object Storage Bucket for export review
    usePseudonymInfoYesStringEnhance infrastructure management rights (Y/N)

    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.