파일 업로드(Upload File)

기존 데이터셋에 파일의 바이너리 내용을 업로드합니다. 요청 본문은 파일 바이트이며 Content-Type은 application/octet-stream이어야 합니다. 기본적으로 기본 브랜치의 새 트랜잭션에 업로드하며, 대부분의 플랫폼 인스턴스에서 기본 브랜치는 master입니다. 같은 파일 경로가 이미 있으면 갱신된 뷰에는 가장 최근 버전만 보입니다.

트랜잭션 선택

• 특정 브랜치로 업로드하려면 branchId를 지정합니다. 해당 브랜치에 새 트랜잭션을 만들고 커밋합니다. 유형의 기본값은 UPDATE이며 transactionType으로 바꿀 수 있습니다.
• 수동으로 연 트랜잭션에 업로드하려면 transactionRid를 지정합니다. 여러 파일을 같은 트랜잭션에 올릴 때 사용할 수 있습니다. 파일 업로드 후에는 해당 트랜잭션을 별도로 커밋합니다.

브랜치 자동 트랜잭션 방식과 수동 트랜잭션 방식의 인수를 임의로 섞지 않습니다. 지원하지 않는 조합에는 InvalidParameterCombination이 발생합니다.

HTTP 요청

POST /api/v1/datasets/{datasetRid}/files:upload

작업 식별자는 v1.uploadFile입니다. OAuth 클라이언트에는 api:datasets-write 권한 범위가 필요합니다. 각 호출에는 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

파일의 바이너리 내용을 본문에 직접 넣습니다. Content-Type: application/octet-stream을 사용합니다.

응답

응답 형식은 File입니다.

가상 데이터셋에 q3-data/my-file.csv를 업로드한 경우의 응답 예시입니다.

{
  "path": "q3-data/my-file.csv",
  "transactionRid": "ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d",
  "sizeBytes": "74930",
  "updatedTime": "2022-10-10T16:44:55.192Z"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시의 리소스 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

아래 예제는 브랜치를 지정하여 API가 트랜잭션을 생성하고 커밋하는 방식입니다. 수동으로 연 트랜잭션에는 branchId 및 자동 생성용 옵션 대신 transactionRid를 사용합니다.

UPLOAD_FILE에는 업로드할 실제 로컬 파일 경로를 제공합니다. 파일을 바이너리로 보내며 JSON 또는 multipart 본문으로 바꾸지 않습니다.

cURL

curl -X POST \
	-H "Content-type: application/octet-stream" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files:upload?filePath=q3-data%2Fmy-file.csv&branchId=master&transactionType=APPEND" \
	--data-binary "@${UPLOAD_FILE}"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/octet-stream",
    "authorization": "Bearer {}".format(TOKEN)
}

with open(os.environ["UPLOAD_FILE"], "rb") as file_body:
    response = requests.post('https://{}/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files:upload?filePath=q3-data%2Fmy-file.csv&branchId=master&transactionType=APPEND'.format(HOSTNAME), headers=headers, data=file_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 UploadFileExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import java.io.File;
import org.apache.http.entity.FileEntity;

public class UploadFileExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files:upload?filePath=q3-data%2Fmy-file.csv&branchId=master&transactionType=APPEND");
            request.addHeader("content-type", "application/octet-stream");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new FileEntity(new File(System.getenv("UPLOAD_FILE"))));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다. 업로드 예제의 import 구문을 사용할 때는 ES 모듈로 실행합니다.

import { readFileSync } from "node:fs";

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files:upload?filePath=q3-data%2Fmy-file.csv&branchId=master&transactionType=APPEND`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/octet-stream',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: readFileSync(process.env.UPLOAD_FILE)
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files:upload?filePath=q3-data%2Fmy-file.csv&branchId=master&transactionType=APPEND" `
	-Method Post `
	-Headers $headers `
	-ContentType application/octet-stream `
	-InFile $env:UPLOAD_FILE

$response.content