Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

트랜잭션 커밋(Commit Transaction) (V2)

열린 트랜잭션을 커밋합니다. 그 트랜잭션에서 수행한 파일 변경을 보존하고 브랜치가 해당 트랜잭션을 가리키도록 갱신합니다. 트랜잭션이 열린 상태가 아니면 TransactionNotOpen이 발생합니다.

같은 트랜잭션에 파일을 여러 개 업로드한 경우, 필요한 파일 변경을 모두 마친 뒤 이 작업으로 확정합니다.

HTTP 요청

POST /api/v2/datasets/{datasetRid}/transactions/{transactionRid}/commit

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
datasetRidstring필수작업 대상 데이터셋의 RID입니다.ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da
transactionRidstring필수트랜잭션의 RID입니다.ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 Transaction입니다.

이름자료형필수 여부의미와 조건예시 값
ridstring필수트랜잭션의 RID입니다.ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4
transactionTypeenum필수트랜잭션 유형입니다. 허용 값: APPEND, UPDATE, SNAPSHOT, DELETE.APPEND
statusenum필수트랜잭션 상태입니다. 허용 값: ABORTED, COMMITTED, OPEN.COMMITTED
createdTimestring (ISO 8601)필수트랜잭션 생성 시각이며 ISO 8601 형식입니다.2020-09-30T14:30:00Z
closedTimestring (ISO 8601)선택트랜잭션 종료 시각이며 ISO 8601 형식입니다.2020-09-30T21:00:00Z

가상 데이터셋의 트랜잭션을 커밋한 경우의 응답 예시입니다.

{
  "transactionType": "APPEND",
  "createdTime": "2020-09-30T14:30:00Z",
  "rid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4",
  "closedTime": "2020-09-30T21:00:00Z",
  "status": "COMMITTED"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
DatasetNotFoundNOT_FOUND404데이터셋을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid
TransactionNotFoundNOT_FOUND404데이터셋에서 트랜잭션을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, transactionRid
CommitTransactionPermissionDeniedPERMISSION_DENIED403트랜잭션을 커밋할 권한이 없습니다.datasetRid, transactionRid
TransactionNotOpenINVALID_ARGUMENT400지정 트랜잭션이 열린 상태가 아닙니다.datasetRid, transactionRid, transactionStatus

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 RID, 이름과 파일 경로는 예시이며 실제 작업 대상으로 바꾸어야 합니다.

cURL

curl -X POST \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.post('https://{}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 CommitTransactionExample.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;

public class CommitTransactionExample {
    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/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

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

fetch(`https://${HOSTNAME}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit`, {
    method: 'POST',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).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/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit" `
	-Method Post `
	-Headers $headers

$response.content