연결된 객체 목록(List Linked Objects) (V2)

시작 객체와 링크 API 이름을 지정하여 연결된 객체를 조회합니다. 시작 객체의 기본 키와 연결 대상 객체의 기본 키를 구분합니다.

기본 페이지 크기는 1,000이며 반환 페이지가 더 작거나 클 수 있습니다. 결과가 더 남아 있으면 적어도 한 항목을 반환합니다. snapshot=false가 기본값이며 조회 중 데이터가 바뀌면 중복이나 누락이 발생할 수 있습니다. snapshot=true이면 페이지 조회를 시작하기 전의 일관된 상태를 사용합니다.

OSv1 기반 객체는 누적 최대 10,000개를 반환합니다. 10,000개를 반환한 뒤 결과가 더 남은 상태에서 다음 페이지를 요청하면 ObjectsExceededLimit이 발생합니다. OSv2에는 이 누적 제한을 적용하지 않습니다. null 속성은 생략하며 기본 반환에서는 벡터 속성을 제외합니다. 기본 키는 속성 선택과 관계없이 반환합니다.

HTTP 요청

GET /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}

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

경로 매개변수

쿼리 매개변수

쿼리 매개변수는 모두 선택 사항입니다.

orderBy에서는 각 속성 앞에 properties. 또는 p.를 붙이고, 뒤에 :asc 또는 :desc를 지정합니다. 기본 방향은 오름차순입니다.

orderBy=properties.lastName:asc
orderBy=properties.lastName,properties.firstName,properties.age:desc

properties.lastName:asc를 p.lastName:asc로 줄여 쓸 수도 있습니다.

branch 값의 예는 ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252입니다.

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListLinkedObjectsResponseV2입니다.

data의 구조

배열 항목은 OntologyObjectV2이며 자료형은 map<PropertyApiName, PropertyValue>입니다.

맵의 키는 PropertyApiName(string), 값은 PropertyValue(any)입니다.

키: 속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다.

자료형별 JSON 표현은 객체 속성 값을 따릅니다.

연결된 객체 목록의 응답 예시입니다.

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "__rid": "ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136",
      "__primaryKey": 80060,
      "__apiName": "Employee",
      "id": 80060,
      "firstName": "Anna",
      "lastName": "Smith"
    },
    {
      "__rid": "ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086137",
      "__primaryKey": 51060,
      "__apiName": "Employee",
      "id": 51060,
      "firstName": "James",
      "lastName": "Matthews"
    }
  ]
}

개별 오류

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

요청 예제

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

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objects/employee/50030/links/directReport?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/objects/employee/50030/links/directReport?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListLinkedObjectsV2Example.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 ListLinkedObjectsV2Example {
    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/objects/employee/50030/links/directReport?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/objects/employee/50030/links/directReport?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/objects/employee/50030/links/directReport?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" `
	-Headers $headers

$response.content