객체 유형 조회(Get Object Type) (V1)

객체 유형의 API 이름으로 정의를 조회합니다. 표시 이름을 대신 사용하지 않습니다. API 이름은 List Object Types 또는 Ontology Manager에서 확인합니다.

쿼리 매개변수와 요청 본문은 없습니다. 응답은 ObjectType이며 apiName, status, rid가 필수입니다. 선택 필드는 legacyObjectTypeId, displayName, description, visibility, primaryKey, properties입니다.

status는 ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED 중 하나이고 visibility는 NORMAL, PROMINENT, HIDDEN 중 하나입니다. 기본 키는 속성 API 이름 목록이며 속성 맵의 각 값은 필수 baseType과 선택적인 description, displayName, legacyPropertyId를 가진 Property입니다. 전체 유형 표현과 필드 조건은 객체 유형 자료형을 따릅니다.

HTTP 요청

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

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

JSON 응답 예시

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

{
  "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.0381eda6-69bb-4cb7-8ba0-c6158e094a04",
  "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/employee"

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

Java

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

$response.content