get-box-history

VPC環境で利用できます。

Box履歴を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/box/get-box-history

リクエストヘッダ

Datafence APIで共通して使用されるヘッダの詳細は、Datafenceのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	Required	Datafence番号
`page`	Integer	Optional	ページ番号 0~100
`size`	Integer	Optional	ページごとの項目数 1~100

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-history?fenceId=1&page=1&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	レスポンス結果数
`content`	Array	-	Box履歴リスト

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`boxId`	Integer	-	Box番号
`boxName`	String	-	Box名
`description`	String	-	Boxの説明
`statusCode`	String	-	Boxの状態コード `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: インフラ作成中 `USE`: 利用中 `ING`: 変更中 `RETURN`: 返却中 `TERMINATE`: 返却完了
`statusName`	String	-	Boxの状態名 `インフラ作成中` \| `利用中` \| `変更中` \| `返却中` \| `返却完了`
`createDate`	String	-	Boxの作成日時 ISO 8601形式(UTC+9を含む)
`endDate`	String	-	Boxの返却日時 ISO 8601形式(UTC+9を含む)

レスポンスステータスコード

Datafence APIで共通して使用されるレスポンスステータスコードの詳細は、Datafence APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "totalCount": 7,
  "content": [
    {
      "boxId": "-",
      "boxName": "box7",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-03-18T17:42:43+09:00",
      "endDate": "2025-03-19T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box6",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-03-05T17:33:25+09:00",
      "endDate": "2025-03-10T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box5",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-03-05T15:29:22+09:00",
      "endDate": "2025-03-09T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box4",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-02-26T10:35:03+09:00",
      "endDate": "2025-03-01T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box3",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-02-18T11:56:40+09:00",
      "endDate": "2025-02-20T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box2",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "返却完了",
      "createDate": "2025-01-09T15:16:35+09:00",
      "endDate": "2025-01-12T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box1",
      "description": "-",
      "statusCode": "USE",
      "statusName": "利用中",
      "createDate": "2025-01-09T13:51:10+09:00"
    }
  ]
}