뷰 조회(Get View) (V2)

뷰 자체의 데이터셋 RID로 메타데이터를 조회합니다. 뷰가 가리키는 기반 데이터셋, 브랜치와 기본 키 설정을 확인할 수 있습니다.

요청 본문은 없습니다. 뷰가 없거나 브랜치가 유효하지 않거나 토큰이 접근할 수 없으면 ViewNotFound가 발생합니다.

HTTP 요청

GET /api/v2/datasets/views/{viewDatasetRid}

작업 식별자는 v2.getView입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다.

응답 구조

응답 형식은 View입니다.

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.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "stopPropagatingMarkingIds": [
        "18212f9a-0e63-4b79-96a0-aae04df23336"
      ],
      "branch": "master"
    }
  ],
  "branch": "master",
  "primaryKey": {
    "columns": [
      "order_id"
    ],
    "resolution": {
      "type": "unique"
    }
  }
}

개별 오류

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111?branch=master"

Python

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

import os
import requests

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

response = requests.get('https://{}/api/v2/datasets/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111?branch=master'.format(HOSTNAME), headers=headers)
print(response)

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class GetViewExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/datasets/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111?branch=master");
            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/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111?branch=master`, {
    method: 'GET',
    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/views/ri.foundry.main.dataset.11111111-1111-4111-8111-111111111111?branch=master" `
	-Headers $headers

$response.content