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
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| pageNo | No | Integer | 1 ~ 100 | ページ番号 |
| pageSize | No | Integer | 1 ~ 100 | ページごとに照会する項目数 |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | リクエスト情報エラー |
| 401 | 認証失敗 |
| 403 | リクエスト情報に対する権限なし |
| 404 | リソースが存在しない |
| 500 | サーバエラー |
例
リクエスト例
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-list
レスポンス例
{
"totalCount": 1,
"content": [
{
"dataBoxFrameNo": "1046",
"dataBoxFrameName": "frame-dev-20230315",
"dataBoxCount": "1",
"createDate": "2023-03-15 10:53:10",
"statusCode": "SET_USE",
"statusName": "Using"
}
]
}
プロパティ
| 項目 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| totalCount | Yes | Integer | Data Box Frameの総数 | |
| dataBoxFrameNo | Yes | String | Data Box Frame番号 | |
| dataBoxFrameName | Yes | String | Data Box Frame名 | |
| dataBoxCount | Yes | String | Data Box Frame内の Data Boxの数 | |
| createDate | Yes | String | Data Box Frameの作成日時 | |
| statusCode | Yes | String | Data Box Frameのステータスコード | |
| statusName | Yes | String | Data Box Frameのステータス名 |
エラーコード
| HTTP Status Code | リターンコード | 説明 |
|---|---|---|
| 400 | 10001, 130*** | リクエスト情報とパラメータエラー |
| 403 | 10002 | リクエスト情報に対する権限なし |
| 404 | 10009 | リソースが存在しない |
| 500 | 130000 | サービス内部エラー |
| 500 | 139999 | 連携サービス APIの呼び出しエラー |
この記事は役に立ちましたか?