get-data-box-list
    • PDF

    get-data-box-list

    • PDF

    記事の要約

    Data Box Frame内の Data Boxのリストを照会します。

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

    リクエスト

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    dataBoxFrameNoYesIntegerData Box Frame番号
    pageNoNoInteger1 ~ 100ページ番号
    pageSizeNoInteger1 ~ 100ページごとに照会する項目数

    レスポンス

    HTTPステータスコード説明
    200成功
    400リクエスト情報エラー
    401認証失敗
    403リクエスト情報に対する権限なし
    404リソースが存在しない
    500サーバエラー

    リクエスト例

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

    レスポンス例

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

    プロパティ

    項目要否タイプ制約事項説明
    totalCountYesIntegerData Boxの総数
    dataBoxNoYesStringData Box番号
    dataBoxNameYesStringData Box名
    createDateYesStringData Boxの作成日時
    statusCodeYesStringData Boxのステータスコード
    statusNameYesStringData Boxのステータス名
    memoYesStringData Boxメモ
    disabledNoBooleanData Boxへのアクセス可否(for Sub Account)

    エラーコード

    HTTP Status Codeリターンコード説明
    200-一般的なリクエスト成功
    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.