뷰 생성(Create View) (V2)

상위 폴더에 새 View를 만듭니다. 뷰가 읽을 기반 데이터셋, 사용할 브랜치와 선택적인 기본 키를 지정합니다. 기반 데이터셋에는 스키마가 있어야 하며, 뷰와 같은 프로젝트에 있거나 그 프로젝트의 리소스 참조로 등록되어야 합니다.

경로와 쿼리 매개변수는 없습니다. 필수 본문은 CreateViewRequest입니다.

기반 데이터셋 항목의 datasetRid는 필수이고 branch는 생략하면 뷰의 브랜치를 사용합니다. stopPropagatingMarkingIds는 상속을 중단할 보안 표지 목록이며 각 표지에 대한 DECLASSIFY 권한이 필요합니다. 같은 표지가 여러 입력에 있으면 입력별로 모두 지정해야 상속을 중단합니다.

기본 키를 지정하면 열 목록이 비어 있지 않아야 하고 스키마에 존재하는 허용 유형이어야 합니다. 필수 resolution은 unique 또는 duplicate입니다. View 자료형에 전체 필드와 중복 처리 조건이 있습니다. 아래 예시는 order_id가 고유하다고 보장하는 가상 데이터셋을 사용합니다.

HTTP 요청

POST /api/v2/datasets/views

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

JSON 요청 예시

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

{
  "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"
    }
  }
}

응답 구조

응답 형식은 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 -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/views" \
	-d '{"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"}}}'

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 = {'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'}}}

response = requests.post('https://{}/api/v2/datasets/views'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 CreateViewExample.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 CreateViewExample {
    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");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"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\"}}}", 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`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: JSON.stringify({"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"}}})
}).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" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body '{"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"}}}'

$response.content