객체 속성의 메타데이터
PropertyV2는 속성 RID와 자료형을 필수로 가지며 표시 이름, 설명, 상태, 가시성과 값 유형 및 표시 형식 등의 메타데이터를 반환합니다. 속성 맵의 키는 속성 API 이름입니다.
상태와 데이터 제약
속성의 상태는 active, experimental, deprecated, example으로 구분합니다. deprecated에는 메시지와 종료 예정 시각이 필수이며 대체 속성 RID는 선택입니다. example은 가상 데이터에 기반한 시험용 속성입니다.
dataConstraints.nullability는 매핑된 데이터소스와 액션으로 생성한 값의 null 허용 여부를 나타냅니다. NOT_NULLABLE이어도 해당 데이터소스 매핑에 객체가 없으면 null을 관찰할 수 있습니다.
typeClasses는 kind와 name으로 구성한 추가 메타데이터이며 이를 사용하는 애플리케이션이 해석합니다. 실제 속성값의 형식은 JSON 표현을 따릅니다.
전체 필드
객체 속성의 상세 정의입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
description | string | 선택 | ||
displayName | string | 선택 | 표시 이름입니다. | |
dataType | union | 필수 | 온톨로지 객체 속성의 자료형입니다. | |
rid | string | 필수 | 속성의 고유 리소스 식별자입니다. | |
status | union<deprecated, active, experimental, example> | 선택 | 속성 유형의 실험, 활성, 사용 중단 예정 또는 예제 상태입니다. | |
visibility | enum | 선택 | 허용값: NORMAL, PROMINENT, HIDDEN. | |
valueTypeApiName | string | 선택 | camelCase 형식의 값 유형 API 이름입니다. | |
valueFormatting | union<date, number, boolean, knownType, timestamp> | 선택 | UI에서 속성값을 표시하는 형식입니다. 실험적 기능이므로 향후 바뀔 수 있습니다. 숫자의 단위, 비율과 축약, 날짜와 시각의 패턴, boolean 표시 문자열 및 Foundry 식별자 형식을 지정합니다. | |
typeClasses | list<TypeClass> | 선택 | ||
dataConstraints | object | 선택 | 속성의 null 허용 여부 같은 데이터 제약입니다. |
dataType의 구조
전체 22가지 분기는 속성 자료형을 따릅니다.
status의 구조
분기 deprecated
속성 유형의 사용 종료를 예고하는 상태이며 지정한 deadline에 따라 제거될 예정입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: deprecated. | deprecated |
message | string | 필수 | ||
deadline | string (date-time) | 필수 | ||
replacedBy | string | 선택 | 속성의 고유 리소스 식별자입니다. |
분기 active
급작스러운 변경 없이 사용자 대상 작업에 사용할 수 있는 활성 상태입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: active. | active |
분기 experimental
개발 중인 속성 유형입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: experimental. | experimental |
분기 example
가상 데이터로 만든 예제 속성입니다. 실제 작업에 사용하지 않으며 작업을 시험할 때 사용할 수 있습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: example. | example |
valueFormatting의 구조
전체 표시 분기와 옵션은 속성값 표시 형식을 따릅니다.
typeClasses의 구조
배열 항목은 TypeClass이며 자료형은 object입니다.
온톨로지를 사용하는 애플리케이션이 해석할 수 있는 추가 메타데이터입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
kind | string | 필수 | 타입 클래스의 네임스페이스입니다. | |
name | string | 필수 | 타입 클래스의 값입니다. |
dataConstraints의 구조
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
nullability | enum | 선택 | 매핑된 데이터소스의 값과 액션으로 만든 값에 null을 허용할지 나타냅니다. 객체가 해당 데이터소스 매핑에 없으면 null 값이 관찰될 수 있습니다. 허용값: NULLABLE, NOT_NULLABLE. |