객체 유형과 링크 유형의 메타데이터
객체 유형의 정의는 API 이름, 기본 키와 제목 속성 및 속성 명세를 제공합니다. 실제 객체의 속성값과 구분하여 조회합니다.
ObjectTypeV2
릴리스 상태는 ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED입니다. icon은 blueprint 분기이며 이름과 16진수 색상 코드를 가집니다. 아이콘 이름은 Blueprint 아이콘에서 확인할 수 있습니다.
aliases는 검색용 동의어입니다. 목록 조회에서는 비어 있으며 RID 기반 조회로 확인합니다. datasources는 includeDatasources=true를 지원하는 요청에서 채우고 사용자가 볼 수 있는 원천만 포함합니다.
온톨로지의 객체 유형 정의입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
apiName | string | 필수 | 카멜 표기법의 객체 유형 API 이름입니다. 실제 이름과 대소문자는 List Object Types 또는 Ontology Manager에서 확인합니다. | |
displayName | string | 필수 | 표시 이름입니다. | |
status | enum | 필수 | 엔터티의 릴리스 상태입니다. 허용값: ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED. | ACTIVE |
description | string | 선택 | 객체 유형의 설명입니다. | |
pluralDisplayName | string | 필수 | 객체 유형의 복수형 표시 이름입니다. | |
icon | union<blueprint> | 필수 | 현재 blueprint 아이콘 분기를 사용하는 객체입니다. | |
primaryKey | string | 필수 | 기본 키로 사용하는 속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다. | |
properties | map<PropertyApiName, PropertyV2> | 선택 | 속성 API 이름에서 속성 정의로 대응하는 맵입니다. | |
rid | string | 필수 | 객체 유형의 고유 RID입니다. | |
titleProperty | string | 필수 | 객체의 제목으로 표시할 속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다. | |
visibility | enum | 선택 | 객체 유형의 권장 표시 수준입니다. 허용값: NORMAL, PROMINENT, HIDDEN. | |
aliases | list<string> | 선택 | 객체 유형을 검색할 때 사용할 대체 이름과 동의어입니다. RID 기반 조회에서 채우며 List Object Types에서는 항상 비어 있습니다. | |
datasources | list<ObjectTypeDatasource> | 선택 | 사용자가 볼 수 있는 객체 유형의 기반 데이터소스입니다. loadOntologyMetadata 또는 includeDatasources=true를 지원하는 요청에서 채웁니다. 접근 가능한 데이터소스가 없으면 목록이 비어 있을 수 있습니다. |
icon의 구조
분기 blueprint
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: blueprint. | blueprint |
color | string | 필수 | 16진수 색상 코드입니다. | |
name | string | 필수 | 객체 유형을 표현하는 Blueprint 아이콘 이름입니다. |
properties의 구조
맵의 키는 속성 API 이름이며 값의 전체 구조는 PropertyV2를 따릅니다.
datasources의 구조
기반 원천의 10가지 분기와 매핑은 데이터소스를 따릅니다.
ObjectTypeFullMetadata
기본 객체 유형에 방향별 발신 링크 정의, 구현 인터페이스와 속성 대응 정보를 더한 구조입니다. 인터페이스 및 공유 속성 이름과 로컬 속성 이름의 매핑 방향은 인터페이스 구현에서 설명합니다.
성공 응답입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
objectType | object | 필수 | 온톨로지의 객체 유형 정의입니다. | |
linkTypes | list<LinkTypeSideV2> | 선택 | ||
implementsInterfaces | list<InterfaceTypeApiName> | 선택 | 객체 유형이 구현하는 인터페이스 목록입니다. | |
implementsInterfaces2 | map<InterfaceTypeApiName, ObjectTypeInterfaceImplementation> | 선택 | 객체 유형이 구현하는 인터페이스의 API 이름에서 구현 정보로 대응하는 맵입니다. | |
sharedPropertyTypeMapping | map<SharedPropertyTypeApiName, PropertyApiName> | 선택 | 공유 속성 유형 API 이름에서 이를 구현한 로컬 속성 API 이름으로 대응하는 맵입니다. |
objectType의 구조
위의 ObjectTypeV2 구조입니다.
linkTypes의 구조
아래의 LinkTypeSideV2 항목 목록입니다.
implementsInterfaces의 구조
배열 항목은 InterfaceTypeApiName이며 자료형은 string입니다.
UpperCamelCase 형식의 인터페이스 API 이름입니다. List Interface Types 또는 Ontology Manager에서 확인합니다.
implementsInterfaces2의 구조
전체 구현 정보는 인터페이스 구현을 따릅니다.
sharedPropertyTypeMapping의 구조
맵의 키는 SharedPropertyTypeApiName(string), 값은 PropertyApiName(string)입니다.
키: lowerCamelCase 형식의 공유 속성 유형 API 이름입니다. List Shared Property Types 또는 Ontology Manager에서 확인합니다.
속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다.
LinkTypeSideV2
발신 링크의 한쪽 방향을 나타냅니다. objectTypeApiName은 연결된 객체 유형이고 cardinality는 ONE 또는 MANY입니다.
foreignKeyPropertyApiName이 있으면 현재 객체 유형의 외래 키입니다. 없으면 다대다 링크이거나 외래 키가 연결된 객체 쪽에 있는 경우입니다. 이 필드의 부재만으로 다대다라고 판단하지 않습니다.
성공 응답입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
apiName | string | 필수 | 링크 유형의 API 이름입니다. Ontology Manager에서 확인합니다. | |
displayName | string | 필수 | 표시 이름입니다. | |
status | enum | 필수 | 엔터티의 릴리스 상태입니다. 허용값: ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED. | ACTIVE |
objectTypeApiName | string | 필수 | 카멜 표기법의 객체 유형 API 이름입니다. 실제 이름과 대소문자는 List Object Types 또는 Ontology Manager에서 확인합니다. | |
cardinality | enum | 필수 | 허용값: ONE, MANY. | |
foreignKeyPropertyApiName | string | 선택 | 속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다. | |
linkTypeRid | string | 필수 |