Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

V1 객체 유형과 링크 메타데이터

객체 유형(ObjectType)은 Foundry 온톨로지의 업무 대상 종류를 정의합니다. 메타데이터 API는 유형의 이름, 상태, 기본 키와 속성 정의를 반환합니다. 바깥쪽 링크 메타데이터는 이 유형에서 연결된 다른 유형과 카디널리티를 설명합니다.

작업

ObjectType

필드자료형필수 여부의미
apiNamestring필수객체 유형의 API 이름
legacyObjectTypeIdstring선택이전 식별자. 새 앱에서는 사용을 권장하지 않으며 Ontology Manager에서 확인 가능
displayNamestring선택표시 이름
statusenum필수ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED
descriptionstring선택객체 유형 설명
visibilityenum선택권장 표시 수준. NORMAL, PROMINENT, HIDDEN
primaryKeylist<PropertyApiName>선택객체를 고유하게 식별하는 속성의 API 이름 목록
propertiesmap<PropertyApiName, Property>선택속성 API 이름에서 속성 정의로의 맵
ridstring필수다른 Foundry API와 함께 사용할 수 있는 객체 유형 RID

PropertyApiName은 속성의 API 이름을 나타내는 문자열입니다. 이름은 Get Object Type 또는 Ontology Manager에서 확인합니다. 표시 이름에서 API 이름을 추정하거나 입력의 대소문자를 임의로 바꾸지 않습니다.

Property

필드자료형필수 여부의미
descriptionstring선택속성 설명
displayNamestring선택표시 이름
baseTypestring필수데이터 값의 유형 표현
legacyPropertyIdstring선택이전 속성 식별자. 새 앱에서는 사용을 권장하지 않으며 Ontology Manager에서 확인 가능

baseType은 고정된 열거형이 아니라 중첩 가능한 유형 표현 문자열입니다. 다음과 같은 표현을 사용하며 반환된 식별자의 대소문자는 유지합니다.

유형표현
ArrayArray<T>. 예: Array<String>
AttachmentAttachment
BooleanBoolean
ByteByte
CipherTextCipherText
DateLocalDate
DecimalDecimal
DoubleDouble
FloatFloat
IntegerInteger
LongLong
MarkingMarking
OntologyObjectOntologyObject<T>. T는 참조하는 객체 유형의 API 이름
ShortShort
StringString
StructStruct<T>. T는 필드 이름과 유형의 쌍. 예: Struct<{ firstName: String, lastName: string }>
TimeseriesTimeSeries<T>. 열거형 시계열은 T가 String, 수치 시계열은 Double
TimestampTimestamp

배열의 원소가 구조체인 형태처럼 유형 표현을 중첩할 수 있습니다.

LinkTypeSide

필드자료형필수 여부의미
apiNamestring필수링크 유형의 API 이름
displayNamestring필수표시 이름
statusenum필수ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED
objectTypeApiNamestring필수연결 대상 객체 유형의 API 이름
cardinalityenum필수ONE 또는 MANY
foreignKeyPropertyApiNamestring선택연결에 사용하는 외래 키 속성의 API 이름

링크 API 이름은 Ontology Manager에서 확인합니다. 링크 정의를 조회하는 작업과 해당 링크로 연결된 실제 객체를 조회하는 작업은 구분합니다.