Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

기반 데이터셋 제거(Remove Backing Datasets) (V2)

뷰에서 지정한 기반 데이터셋을 제거합니다. 제거로 인해 다음 뷰 갱신 때 SNAPSHOT 트랜잭션이 발생합니다. 존재하지 않는 제거 대상을 지정한 것만으로 오류를 반환하지는 않습니다. 뷰 자체가 없거나 유효하지 않은 브랜치 및 접근 권한 문제는 별도로 처리합니다.

경로의 viewDatasetRid는 필수 문자열이며 쿼리 매개변수는 없습니다. 필수 본문은 RemoveBackingDatasetsRequest입니다.

HTTP 요청

POST /api/v2/datasets/views/{viewDatasetRid}/removeBackingDatasets

작업 식별자는 v2.removeBackingDatasets입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:datasets-write 권한 범위가 필요합니다.

요청 본문 필드

필드자료형필수 여부의미
branchstring선택뷰 브랜치
backingDatasetslist<ViewBackingDataset>선택작업 대상 기반 데이터셋 목록
backingDatasets[].datasetRidstring필수기반 데이터셋 RID
backingDatasets[].branchstring선택입력 브랜치. 생략하면 뷰의 브랜치
backingDatasets[].stopPropagatingMarkingIdslist<MarkingId>선택이 입력에서 상속을 중단할 보안 표지 ID

보안 표지 상속 중단을 지정하려면 각 표지의 DECLASSIFY 권한이 필요합니다. 동일한 표지가 여러 입력에 있으면 각 입력에서 모두 지정해야 합니다. 기반 데이터셋은 뷰 프로젝트에 있거나 프로젝트의 리소스 참조로 등록되어야 합니다. ViewBackingDataset의 조건을 따릅니다.

JSON 요청 예시

가상 뷰와 기반 데이터셋을 사용하는 요청 본문 예시입니다.

{
  "backingDatasets": [
    {
      "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "stopPropagatingMarkingIds": [
        "18212f9a-0e63-4b79-96a0-aae04df23336"
      ],
      "branch": "master"
    }
  ],
  "branch": "master"
}

응답 구조

응답 형식은 View입니다.

필드자료형필수 여부의미
viewNamestring필수표시 이름
datasetRidstring필수뷰 자체의 RID
parentFolderRidstring필수상위 폴더 RID
branchstring선택뷰 브랜치
backingDatasetslist<ViewBackingDataset>선택기반 데이터셋과 브랜치 및 보안 표지 상속 중단 설정
primaryKeyobject선택기본 키 열, 필수 resolution과 유형별 중복 해결 설정

ViewBackingDataset과 primaryKey의 모든 필드 및 보안과 중복 처리 조건은 View 자료형을 따릅니다.

두 기반 데이터셋 중 요청한 항목을 제거하고 다른 기반 데이터셋 하나가 남은 가상 응답 예시입니다.

{
  "datasetRid": "ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111",
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "viewName": "My Dataset",
  "backingDatasets": [
    {
      "datasetRid": "ri.foundry.main.dataset.22222222-2222-4222-8222-222222222222",
      "branch": "master"
    }
  ],
  "branch": "master",
  "primaryKey": {
    "columns": [
      "order_id"
    ],
    "resolution": {
      "type": "unique"
    }
  }
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidViewBackingDatasetINVALID_ARGUMENT400기반 데이터셋이 없거나 하나 이상에 접근할 수 없습니다.없음
ViewNotFoundNOT_FOUND404뷰가 없거나 브랜치가 유효하지 않거나 토큰이 접근할 수 없습니다.viewDatasetRid, branch
InputBackingDatasetNotInOutputViewProjectINVALID_ARGUMENT400기반 데이터셋이 뷰와 같은 프로젝트에 있지 않습니다. Filesystem API로 해당 프로젝트의 리소스 참조에 추가하거나 데이터셋을 프로젝트로 옮긴 뒤 다시 요청합니다.viewProjectRid, invalidBackingDatasets
RemoveBackingDatasetsPermissionDeniedPERMISSION_DENIED403뷰의 기반 데이터셋 제거 권한이 거부되었습니다.viewDatasetRid

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111/removeBackingDatasets" \
	-d '{"backingDatasets":[{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","stopPropagatingMarkingIds":["18212f9a-0e63-4b79-96a0-aae04df23336"],"branch":"master"}],"branch":"master"}'

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "backingDatasets": [
        {
            "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
            "stopPropagatingMarkingIds": [
                "18212f9a-0e63-4b79-96a0-aae04df23336"
            ],
            "branch": "master"
        }
    ],
    "branch": "master"
}

response = requests.post('https://{}/api/v2/datasets/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111/removeBackingDatasets'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 RemoveBackingDatasetsExample.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 org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class RemoveBackingDatasetsExample {
    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/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111/removeBackingDatasets");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"backingDatasets\":[{\"datasetRid\":\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\",\"stopPropagatingMarkingIds\":[\"18212f9a-0e63-4b79-96a0-aae04df23336\"],\"branch\":\"master\"}],\"branch\":\"master\"}", ContentType.APPLICATION_JSON));
            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/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111/removeBackingDatasets`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"backingDatasets":[{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","stopPropagatingMarkingIds":["18212f9a-0e63-4b79-96a0-aae04df23336"],"branch":"master"}],"branch":"master"}'
}).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/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111/removeBackingDatasets" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"backingDatasets`":[{`"datasetRid`":`"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`",`"stopPropagatingMarkingIds`":[`"18212f9a-0e63-4b79-96a0-aae04df23336`"],`"branch`":`"master`"}],`"branch`":`"master`"}"

$response.content