객체 유형 RID 일괄 조회(Get Object Type By RID Batch) (V2)

객체 유형 RID로 최대 100개를 조회합니다. 존재하지 않거나 요청 토큰에 필요한 권한이 없는 유형은 응답에서 생략합니다. 결과의 data는 객체 유형 목록입니다.

본문의 requests 배열에 각 objectTypeRid를 지정합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/ontologies/{ontology}/objectTypes/getByRidBatch

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

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`ontology`	`string`	필수	온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다.	`palantir`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`branch`	`string`	선택	객체 유형 정의들을 읽을 Foundry 브랜치입니다. 생략하면 기본 브랜치를 사용합니다. 브랜치는 실험적 기능이며 모든 작업 경로를 지원하지 않습니다.	`ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252`
`preview`	`boolean`	선택	`true`이면 미리보기 단계의 베타 기능을 사용합니다.	`true`

요청 본문

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

이름	자료형	필수 여부	의미와 조건	예시 값
`requests`	`list<GetObjectTypeByRidBatchRequestElement>`	선택

`requests`의 구조

배열 항목은 GetObjectTypeByRidBatchRequestElement이며 자료형은 object입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`objectTypeRid`	`string`	필수	객체 유형의 고유 RID입니다.

객체 유형 RID 한 개를 지정한 요청 본문 예시입니다.

{
  "requests": [
    {
      "objectTypeRid": "ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"
    }
  ]
}

응답

응답 형식은 GetObjectTypeByRidBatchResponse입니다.

성공 응답입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`data`	`list<ObjectTypeV2>`	선택

`data`의 구조

배열 항목은 ObjectTypeV2이며 자료형은 object입니다.

온톨로지의 객체 유형 정의입니다.

전체 필드는 ObjectTypeV2 메타데이터를 따릅니다.

개별 오류

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

요청 예제

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

객체 유형 한 개를 조회하는 예제입니다. 실제 RID 목록을 제공합니다. 예시 Foundry 브랜치 RID는 실제 조회 맥락에 맞게 바꿉니다. 기본 브랜치를 사용하려면 branch 쿼리를 생략합니다. 브랜치는 실험적 기능입니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objectTypes/getByRidBatch?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" \
	-d '{"requests":[{"objectTypeRid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]}'

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 = {'requests': [{'objectTypeRid': 'ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04'}]}

response = requests.post('https://{}/api/v2/ontologies/palantir/objectTypes/getByRidBatch?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를 사용합니다. 클래스 이름에 맞는 GetObjectTypeByRidBatchExample.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 GetObjectTypeByRidBatchExample {
    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/objectTypes/getByRidBatch?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("{\"requests\":[{\"objectTypeRid\":\"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04\"}]}", 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/objectTypes/getByRidBatch?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: JSON.stringify({"requests":[{"objectTypeRid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]})
}).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/objectTypes/getByRidBatch?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body '{"requests":[{"objectTypeRid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]}'

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설