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

기준 객체에서 지정한 링크 유형으로 연결된 객체를 나열합니다. URL 필터로 반환할 객체를 제한할 수 있습니다.

요청 본문은 없습니다. 온톨로지와 객체 유형은 각 목록 API나 Ontology Manager에서, 기본 키는 Get Object Type이나 Ontology Manager에서 확인합니다. 링크 이름은 Ontology Manager에서 확인합니다.

properties의 기본 반환 대상은 Vector를 제외한 전체 속성입니다. 기본 키는 선택하지 않아도 반환되며, 알 수 없는 속성을 지정하면 PropertiesNotFound 오류가 발생합니다. 쉼표 및 반복 매개변수 형식과 정렬 방향은 객체 선택과 정렬을 따릅니다.

페이지와 응답

페이지 간 일관성을 보장하지 않으므로 데이터가 변경되면 누락되거나 반복되는 객체가 생길 수 있습니다. Object Storage V1 기반 객체는 최대 10,000개까지 반환합니다. 추가 결과가 있는 상태에서 이후 페이지를 요청하면 ObjectsExceededLimit 오류가 발생합니다. Object Storage V2에는 이 총반환 한도가 없습니다.

페이지는 요청한 크기보다 작거나 클 수 있지만, 결과가 더 있다면 최소 한 객체를 포함합니다. null 값 속성은 반환하지 않습니다. 응답의 nextPageToken으로 다음 페이지를 요청합니다.

ListLinkedObjectsResponse의 data: list<OntologyObject>와 nextPageToken: string은 모두 선택 필드입니다. 각 객체의 필수 rid와 선택적 properties 맵은 객체 속성값을 따릅니다. 예시는 가상 직원의 직속 보고자 목록입니다.

HTTP 요청

GET /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}

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

JSON 응답 예시

가상 객체 유형의 응답 예시입니다.

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

오류

실패 응답은 공통 API 오류의 형식으로 처리합니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030/links/directReport"

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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030/links/directReport'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 ListLinkedObjectsExample.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 ListLinkedObjectsExample {
    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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030/links/directReport");
            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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030/links/directReport`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030/links/directReport" `
	-Headers $headers

$response.content