get-data-box-list
- Print
- PDF
get-data-box-list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It views the Data Box lists in Data Box Frame.
GET https://{endpoint}/data-box/get-data-box-list
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | Integer | Data Box Frame number | |
| pageNo | No | Integer | 1 ~ 100 | Page number |
| pageSize | No | Integer | 1 ~ 100 | Number of items viewed per page |
Responses
| HTTP status code | Description |
|---|---|
| 200 | Success |
| 400 | Request information error |
| 401 | Authentication failed |
| 403 | No permission to request information |
| 404 | Resource not found |
| 500 | Server error |
Examples
Request examples
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-list?dataBoxFrameNo=1046&pageNo=1&pageSize=10
Response examples
{
"totalCount": 1,
"content": [
{
"dataBoxNo": "194",
"dataBoxName": "BOX#3",
"memo": "",
"createDate": "2023-04-04 16:24:37",
"statusCode": "USE",
"statusName": "Using"
}
]
}
Properties
| Items | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| totalCount | Yes | Integer | Total number of Data Boxes | |
| dataBoxNo | Yes | String | Data Box number | |
| dataBoxName | Yes | String | Data Box name | |
| createDate | Yes | String | Created date of Data Box | |
| statusCode | Yes | String | Status code of Data Box | |
| statusName | Yes | String | Status name of Data Box | |
| memo | Yes | String | Data Box memo | |
| disabled | No | Boolean | Access availability of Data Box (for Sub Account) |
Errors
| HTTP Status Code | Return code | Description |
|---|---|---|
| 200 | - | Successful normal request |
| 400 | 10001, 130*** | Request information and parameter error |
| 403 | 10002 | No permission to request information |
| 404 | 10009 | Resource not found |
| 500 | 130000 | Service internal error |
| 500 | 139999 | Integration service API call error |
Was this article helpful?