객체 유형의 발신 링크 목록(List Outgoing Link Types) (V2)
객체 유형에서 나가는 링크의 정의를 조회합니다. 각 링크는 API 이름, 표시 이름, 상태, 연결된 객체 유형과 방향별 카디널리티 및 링크 RID를 제공합니다.
외래 키 속성이 없으면 다대다 링크이거나 외래 키가 반대쪽 객체 유형에 있을 수 있습니다. 실제 객체의 연결 목록과 링크 유형의 정의는 구분합니다.
HTTP 요청
GET /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes
작업 식별자는 v2.listOutgoingLinkTypesV2입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:ontologies-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
ontology | string | 필수 | 온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다. | palantir |
objectType | string | 필수 | 객체 유형의 API 이름입니다. List Object Types 또는 Ontology Manager에서 확인합니다. | Flight |
쿼리 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
branch | string | 선택 | 발신 링크 유형을 조회할 Foundry 브랜치입니다. 생략하면 기본 브랜치를 사용합니다. 브랜치는 실험적 기능이며 모든 작업 경로를 지원하지 않습니다. | ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252 |
pageSize | integer | 선택 | 요청할 페이지 크기입니다. | |
pageToken | string | 선택 | 페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다. |
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 ListOutgoingLinkTypesResponseV2입니다.
성공 응답입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
nextPageToken | string | 선택 | 다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다. | |
data | list<LinkTypeSideV2> | 선택 | 현재 페이지의 방향별 링크 정의 목록입니다. |
data의 구조
배열 항목은 LinkTypeSideV2이며 자료형은 object입니다.
각 항목은 발신 링크의 한쪽 방향을 나타냅니다. foreignKeyPropertyApiName은 현재 객체 유형에 있는 외래 키 속성의 API 이름입니다. 이 필드가 없으면 다대다 링크이거나 외래 키가 연결된 객체 쪽에 있고 현재 객체 유형에는 기본 키가 있는 경우입니다.
전체 필드는 LinkTypeSideV2 메타데이터를 따릅니다.
발신 링크 정의 목록의 응답 예시입니다.
{
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
"data": [
{
"apiName": "originAirport",
"objectTypeApiName": "Airport",
"cardinality": "ONE",
"foreignKeyPropertyApiName": "originAirportId",
"displayName": "Origin airport",
"status": "ACTIVE",
"linkTypeRid": "ri.ontology.main.link-type.534ce61f-e9b4-408c-a66f-cf4c8d7890a2"
}
]
}
개별 오류
오류 응답 처리는 공통 API 오류 계약을 따릅니다.
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
Flight 유형의 링크 정의를 조회하는 예제입니다. 예시 Foundry 브랜치 RID는 실제 조회 맥락에 맞게 바꿉니다. 기본 브랜치를 사용하려면 branch 쿼리를 생략합니다. 브랜치는 실험적 기능입니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objectTypes/Flight/outgoingLinkTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
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/ontologies/palantir/objectTypes/Flight/outgoingLinkTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListOutgoingLinkTypesV2Example.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 ListOutgoingLinkTypesV2Example {
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/ontologies/palantir/objectTypes/Flight/outgoingLinkTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252");
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/ontologies/palantir/objectTypes/Flight/outgoingLinkTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).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/Flight/outgoingLinkTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" `
-Headers $headers
$response.content