객체 유형 목록(List Object Types) (V1)

지정한 온톨로지의 객체 유형을 페이지로 조회합니다. 한 페이지의 실제 결과 수는 요청한 크기보다 적거나 많을 수 있습니다. 다음 결과가 남아 있으면 현재 페이지에 최소 한 건을 반환합니다.

요청 본문은 없습니다. ListObjectTypesResponse에는 선택적인 data: list<ObjectType>와 nextPageToken이 있습니다. 각 ObjectType의 필수 필드는 apiName, status, rid입니다. 선택 필드는 legacyObjectTypeId, displayName, description, visibility, primaryKey, properties입니다.

properties는 속성 API 이름에서 Property로의 맵이며 Property의 필수 baseType과 선택적인 설명, 표시 이름, 이전 식별자를 포함합니다. 모든 필드와 중첩 유형 표현은 객체 유형 자료형에 있습니다.

HTTP 요청

GET /api/v1/ontologies/{ontologyRid}/objectTypes

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

JSON 응답 예시

가상 온톨로지의 메타데이터 응답 예시입니다.

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "apiName": "employee",
      "description": "A full-time or part-time employee of our firm",
      "primaryKey": [
        "employeeId"
      ],
      "properties": {
        "employeeId": {
          "baseType": "Integer"
        },
        "fullName": {
          "baseType": "String"
        },
        "office": {
          "description": "The unique ID of the employee's primary assigned office",
          "baseType": "String"
        },
        "startDate": {
          "description": "The date the employee was hired (most recently, if they were re-hired)",
          "baseType": "Date"
        }
      },
      "rid": "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44",
      "status": "ACTIVE"
    },
    {
      "apiName": "office",
      "description": "A physical location (not including rented co-working spaces)",
      "primaryKey": [
        "officeId"
      ],
      "properties": {
        "officeId": {
          "baseType": "String"
        },
        "address": {
          "description": "The office's physical address (not necessarily shipping address)",
          "baseType": "String"
        },
        "capacity": {
          "description": "The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)",
          "baseType": "Integer"
        }
      },
      "rid": "ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9",
      "status": "ACTIVE"
    }
  ]
}

오류

실패 응답은 공통 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/objectTypes"

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/objectTypes'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 ListObjectTypesExample.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 ListObjectTypesExample {
    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/objectTypes");
            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/objectTypes`, {
    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/objectTypes" `
	-Headers $headers

$response.content