get-export-file-approve-list

Available in VPC

Get the list of export reviews within a datafence.

Request

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

Method	URI
GET	/api/v1/export-approval/get-export-file-approve-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 See get-datafence.
`boxId`	Integer	Required	Box number See get-box-list.
`status`	String	Optional	Export request status code See File export 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-approval/get-export-file-approve-list?fenceId=26&boxId=74&status=EXPORTED&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
`reviewBucketName`	String	-	Bucket name for export review
`content`	Array	-	Export review target list

`content`

The following describes content.

Field	Type	Required	Description
`fenceId`	Integer	-	Datafence number
`fenceName`	String	-	Datafence name
`boxId`	Integer	-	Box number
`boxName`	String	-	Box name
`boxStatus`	String	-	Box status code `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: creating infrastructure `USE`: in use `ING`: changing `RETURN`: terminating `TERMINATE`: termination completed
`fileId`	Integer	-	Export request number
`requesterId`	String	-	Export requester ID
`screenFilePath`	String	-	Export review target file name File name: Upon export request, set to {Export request date and time (ISO 8601 format)}_{Import number (`fileId`)}_{Source file name (`sourceFilePath`)}.
`statusCode`	String	-	Export review status code See File export status code.
`statusName`	String	-	Export review status name See File export status code.
`description`	String	-	Description for the export request
`fileDescription`	String	-	Description for the file requested for export
`exportPurpose`	String	-	Export purpose
`rejectReason`	String	-	Export request rejection cause
`fileSize`	Integer	-	Export review target file size (MB)
`createDate`	String	-	Export request date and time ISO 8601 format (including UTC+9)
`completeDate`	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": 3,
    "reviewBucketName": "defence001",
    "content": [
        {
            "fenceId": 26,
            "fenceName": "defence001",
            "boxId": 74,
            "boxName": "box1",
            "boxStatus": "USE",
            "fileId": 102,
            "requesterId": "nb********@navercorp.com",
            "screenFilePath": "20250425T162608_117_datafence001.csv",
            "statusCode": "UPLOADED",
            "statusName": "Review requested (file transfer completed)",
            "description": "File export test",
            "fileDescription": "Test file",
            "exportPurpose": "File export test",
            "fileSize": 0,
            "createDate": "2025-04-25T16:26:09+09:00"
        },
        {
            "fenceId": 26,
            "fenceName": "defence001",
            "boxId": 74,
            "boxName": "box1",
            "boxStatus": "USE",
            "fileId": 100,
            "requesterId": "nb********@navercorp.com",
            "screenFilePath": "20250425T160023_117_datafence001.csv",
            "statusCode": "REJECTED",
            "statusName": "Rejected",
            "description": "File export test",
            "fileDescription": "Test file",
            "exportPurpose": "File export test",
            "rejectReason": "-",
            "fileSize": 0,
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:22:03+09:00"
        },
        {
            "fenceId": 26,
            "fenceName": "defence001",
            "boxId": 74,
            "boxName": "box1",
            "boxStatus": "USE",
            "fileId": 99,
            "requesterId": "nb********@navercorp.com",
            "screenFilePath": "20250425T160022_116_sample.xlsx",
            "statusCode": "EXPORTED",
            "statusName": "Approved (bucket storage completed)",
            "description": "File export test",
            "fileDescription": "Test file",
            "exportPurpose": "File export test",
            "fileSize": 2,
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:07:20+09:00"
        }
    ]
}