get-export-file-approve-detail

Prev Next

VPC環境で利用できます。

Datafenceからの持ち出し審査の詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/export-approval/get-export-file-approve-detail

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
fenceId Integer Required Datafence番号
boxId Integer Required Box番号
fileId Integer Required 持ち出し申請番号

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/export-approval/get-export-file-approve-detail?fenceId=26&boxId=74&fileId=102' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
fenceId Integer - Datafence番号
fenceName String - Datafence名
boxId Integer - Box番号
boxName String - Box名
boxStatus String - Boxの状態コード
  • INITIALIZE | USE | ING | RETURN | TERMINATE
    • INITIALIZE: インフラ作成中
    • USE: 利用中
    • ING: 変更中
    • RETURN: 返却中
    • TERMINATE: 返却完了
fileId Integer - 持ち出し申請番号
requesterId String - 持ち出し申請者 ID
screenFilePath String - 持ち出し審査対象のファイル名
  • ファイル名: 持ち出し申請時、{持ち出しの申請日時(ISO 8601形式)}_{持ち込み番号(fileId)}_{Sourceファイル名(sourceFilePath)}に指定
    statusCode String - 持ち出し審査の状態コード
    statusName String - 持ち出し審査の状態名
    description String - 持ち出し申請に関する説明
    fileDescription String - 持ち出し申請ファイルの説明
    exportPurpose String - 持ち出しの目的
    rejectReason String - 持ち出し申請却下の理由
    fileSize Integer - 持ち出し審査対象のファイルサイズ(MB)
    createDate String - 持ち出しの申請日時
    • ISO 8601形式(UTC+9を含む)
    completeDate String - 持ち出し審査日時
    • ISO 8601形式(UTC+9を含む)
    • 持ち出し審査を完了した場合、表示
    resultDate String - 持ち出し審査日時
    • ISO 8601形式(UTC+9を含む)
    • 持ち出し審査を完了した場合、表示

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

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

    レスポンス例

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

    {
        "fenceId": 26,
        "fenceName": "defence001",
        "boxId": 74,
        "boxName": "box1",
        "boxStatus": "USE",
        "fileId": 102,
        "requesterId": "nb********@navercorp.com",
        "screenFilePath": "20250425T162608_117_datafence001.csv",
        "statusCode": "UPLOADED",
        "statusName": "審査のリクエスト(ファイル転送完了)",
        "description": "ファイル持ち出しテスト",
        "fileDescription": "テスト用ファイル",
        "exportPurpose": "ファイル持ち出しテスト",
        "fileSize": 0,
        "createDate": "2025-04-25T16:26:09+09:00"
    }