get-export-list

Prev Next

Available in VPC

Get the list of file export requests in a box.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/export/get-export-list

Request headers

For information about the headers common to all Datafence APIs, see Datafence request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
fenceId Integer Required Datafence number
boxId Integer Required Box number
status String Optional Export request status code
from String Optional Query start date and time
  • yyyyMMddHHmmss format
to String Optional Query end date and time
  • yyyyMMddHHmmss format
page Integer Optional Page number
  • 0-100 (default: 0)
size Integer Optional Number of items per page
  • 1-100 (default: 10)

Request example

The request example is as follows:

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/export/get-export-list?fenceId=26&boxId=74&status=IMPORTED&from=20250401000000&to=20250430000000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
totalCount Integer - Number of response results
content Array - Export request list

content

The following describes content.

Field Type Required Description
fileId Integer - Export request number
fenceId Integer - Datafence number
boxId Integer - Box number
boxName String - Box name
requesterId String - Export requester ID
sourceNasName String - Source NAS name
sourceFilePath String - Export request target file name
targetBucketName String - Target bucket name
statusCode String - Export request status code
statusName String - Export request status name
rejectReason String - Export request rejection cause
  • Display if export review is rejected.
description String - Description for the export request
createDate String - Export request date and time
  • ISO 8601 format (including UTC+9)
resultDate String - Export review date and time
  • ISO 8601 format (including UTC+9)
  • Display when export review is complete.

Response status codes

For information about the HTTP status codes common to all Datafence APIs, see Datafence API response status codes.

Response example

The response example is as follows:

{
    "totalCount": 6,
    "content": [
        {
            "fileId": 102,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "117_datafence001.csv",
            "targetBucketName": "defence001",
            "statusCode": "UPLOADED",
            "statusName": "Review requested (file transfer completed)",
            "description": "File export test",
            "createDate": "2025-04-25T16:26:09+09:00"
        },
        {
            "fileId": 100,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "117_datafence001.csv",
            "targetBucketName": "defence001",
            "statusCode": "REJECTED",
            "statusName": "Rejected",
            "rejectReason": "-",
            "description": "File export test",
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:22:03+09:00"
        },
        {
            "fileId": 99,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "116_sample.xlsx",
            "targetBucketName": "defence001",
            "statusCode": "EXPORTED",
            "statusName": "Approved (bucket storage completed)",
            "description": "File export test",
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:07:20+09:00"
        }
    ]
}