질의 유형 메타데이터
QueryTypeV2는 게시된 질의 버전의 입력과 출력을 설명합니다. 호출할 때는 매개변수의 required와 dataType을 확인하고, 응답은 output에 맞춰 해석합니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
apiName | string | 필수 | 쿼리 함수의 API 이름입니다. | |
description | string | 선택 | ||
displayName | string | 선택 | 표시 이름입니다. | |
parameters | map<ParameterId, QueryParameterV2> | 선택 | ||
output | QueryDataType | 필수 | 온톨로지 질의의 매개변수 또는 출력이 지원하는 자료형입니다. | |
rid | string | 필수 | 함수의 고유 리소스 식별자이며 다른 Foundry API와 연계할 때 사용합니다. | |
version | string | 필수 | 함수 버전은 <major>.<minor>.<patch>-<tag> 형식이며 -<tag>는 생략할 수 있습니다. 예: 1.2.3, 1.2.3-rc1. | |
typeReferences | map<TypeReferenceIdentifier, QueryDataType> | 선택 |
parameters의 구조
맵의 키는 ParameterId(string), 값은 QueryParameterV2(object)입니다.
키: 액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.
쿼리 매개변수의 설명과 자료형 및 필수 여부입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
description | string | 선택 | ||
dataType | QueryDataType | 필수 | 온톨로지 질의의 매개변수 또는 출력이 지원하는 자료형입니다. | |
required | boolean | 필수 |
dataType의 구조
전체 분기와 중첩 구조는 질의의 자료형을 따릅니다.
output의 구조
전체 분기와 중첩 구조는 질의의 자료형을 따릅니다.
typeReferences의 구조
맵의 키는 TypeReferenceIdentifier(string), 값은 QueryDataType(union<date, interfaceObject, struct, string, integer, threeDimensionalAggregation, float, long, unsupported, attachment, array, objectSet, twoDimensionalAggregation, typeReference, timestamp, set, void, entrySet, double, union, geoshape, boolean, mediaReference, null, interfaceObjectSet, object>)입니다.
키: 현재 Query의 typeReferences 맵에서 자료형 정의를 찾을 식별자입니다.
온톨로지 질의의 매개변수 또는 출력이 지원하는 자료형입니다.
전체 분기와 중첩 구조는 질의의 자료형을 따릅니다.
목록의 최신 버전은 가장 최근에 게시한 버전이며 사전 릴리스도 포함합니다. 조회할 버전을 지정하려면 Get Query Type의 version을 사용합니다. 실행 시 버전 선택은 Execute Query의 조건을 따릅니다.