V1 객체 유형과 링크 메타데이터
객체 유형(ObjectType)은 Foundry 온톨로지의 업무 대상 종류를 정의합니다. 메타데이터 API는 유형의 이름, 상태, 기본 키와 속성 정의를 반환합니다. 바깥쪽 링크 메타데이터는 이 유형에서 연결된 다른 유형과 카디널리티를 설명합니다.
작업
- List Object Types: 온톨로지의 객체 유형을 페이지로 조회합니다.
- Get Object Type: API 이름으로 한 객체 유형을 조회합니다.
- List Outgoing Link Types: 객체 유형에서 나가는 링크를 페이지로 조회합니다.
- Get Outgoing Link Type: 한 바깥쪽 링크의 정의를 조회합니다.
ObjectType
| 필드 | 자료형 | 필수 여부 | 의미 |
|---|---|---|---|
apiName | string | 필수 | 객체 유형의 API 이름 |
legacyObjectTypeId | string | 선택 | 이전 식별자. 새 앱에서는 사용을 권장하지 않으며 Ontology Manager에서 확인 가능 |
displayName | string | 선택 | 표시 이름 |
status | enum | 필수 | ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED |
description | string | 선택 | 객체 유형 설명 |
visibility | enum | 선택 | 권장 표시 수준. NORMAL, PROMINENT, HIDDEN |
primaryKey | list<PropertyApiName> | 선택 | 객체를 고유하게 식별하는 속성의 API 이름 목록 |
properties | map<PropertyApiName, Property> | 선택 | 속성 API 이름에서 속성 정의로의 맵 |
rid | string | 필수 | 다른 Foundry API와 함께 사용할 수 있는 객체 유형 RID |
PropertyApiName은 속성의 API 이름을 나타내는 문자열입니다. 이름은 Get Object Type 또는 Ontology Manager에서 확인합니다. 표시 이름에서 API 이름을 추정하거나 입력의 대소문자를 임의로 바꾸지 않습니다.
Property
| 필드 | 자료형 | 필수 여부 | 의미 |
|---|---|---|---|
description | string | 선택 | 속성 설명 |
displayName | string | 선택 | 표시 이름 |
baseType | string | 필수 | 데이터 값의 유형 표현 |
legacyPropertyId | string | 선택 | 이전 속성 식별자. 새 앱에서는 사용을 권장하지 않으며 Ontology Manager에서 확인 가능 |
baseType은 고정된 열거형이 아니라 중첩 가능한 유형 표현 문자열입니다. 다음과 같은 표현을 사용하며 반환된 식별자의 대소문자는 유지합니다.
| 유형 | 표현 |
|---|---|
| Array | Array<T>. 예: Array<String> |
| Attachment | Attachment |
| Boolean | Boolean |
| Byte | Byte |
| CipherText | CipherText |
| Date | LocalDate |
| Decimal | Decimal |
| Double | Double |
| Float | Float |
| Integer | Integer |
| Long | Long |
| Marking | Marking |
| OntologyObject | OntologyObject<T>. T는 참조하는 객체 유형의 API 이름 |
| Short | Short |
| String | String |
| Struct | Struct<T>. T는 필드 이름과 유형의 쌍. 예: Struct<{ firstName: String, lastName: string }> |
| Timeseries | TimeSeries<T>. 열거형 시계열은 T가 String, 수치 시계열은 Double |
| Timestamp | Timestamp |
배열의 원소가 구조체인 형태처럼 유형 표현을 중첩할 수 있습니다.
LinkTypeSide
| 필드 | 자료형 | 필수 여부 | 의미 |
|---|---|---|---|
apiName | string | 필수 | 링크 유형의 API 이름 |
displayName | string | 필수 | 표시 이름 |
status | enum | 필수 | ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED |
objectTypeApiName | string | 필수 | 연결 대상 객체 유형의 API 이름 |
cardinality | enum | 필수 | ONE 또는 MANY |
foreignKeyPropertyApiName | string | 선택 | 연결에 사용하는 외래 키 속성의 API 이름 |
링크 API 이름은 Ontology Manager에서 확인합니다. 링크 정의를 조회하는 작업과 해당 링크로 연결된 실제 객체를 조회하는 작업은 구분합니다.