임시 객체 집합 생성(Create Temporary Object Set) (V2)

객체 집합 정의로 임시 ObjectSet을 만들고 RID를 반환합니다. 생성한 객체 집합은 한 시간 뒤 만료됩니다. 이 API는 미리보기 기능이며 변경되거나 제거될 수 있습니다. 호출할 때 preview=true를 지정합니다.

이 요청은 임시 객체 집합 리소스를 생성합니다. 여러 번 사용할 선택 정의를 전달하고 반환된 objectSetRid를 해당 수명 안에서 사용합니다.

HTTP 요청

POST /api/v2/ontologies/{ontology}/objectSets/createTemporary

작업 식별자는 v2.createTemporaryObjectSetV2입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:ontologies-read, api:ontologies-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

본문 형식은 CreateTemporaryObjectSetRequestV2이며 필수입니다.

objectSet의 구조

전체 정의는 객체 집합 형식을 따릅니다.

Employee 객체 유형을 선택하는 임시 객체 집합의 요청 본문입니다.

{
  "objectSet": {
    "type": "base",
    "objectType": "Employee"
  }
}

응답

응답 형식은 CreateTemporaryObjectSetResponseV2입니다.

생성한 임시 객체 집합의 RID를 반환하는 응답 예시입니다.

{
  "objectSetRid": "ri.object-set.main.temporary-object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

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

온톨로지와 객체 유형의 API 이름, 브랜치는 실제 대상에 맞게 바꿉니다. 기본 브랜치를 사용할 때는 branch를 생략합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" \
	-d '{"objectSet":{"type":"base","objectType":"Employee"}}'

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 = {
    "objectSet": {
        "type": "base",
        "objectType": "Employee"
    }
}

response = requests.post('https://{}/api/v2/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateTemporaryObjectSetV2Example.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 CreateTemporaryObjectSetV2Example {
    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/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"objectSet\":{\"type\":\"base\",\"objectType\":\"Employee\"}}", 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/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"objectSet":{"type":"base","objectType":"Employee"}}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"objectSet`":{`"type`":`"base`",`"objectType`":`"Employee`"}}"

$response.content