V1 쿼리 유형 API
쿼리 유형(QueryType)은 온톨로지에서 실행할 로직의 정의입니다. Query Functions로 생성하며, API 이름과 입력 매개변수, 출력 자료형을 통해 호출 계약을 확인합니다.
| 작업 | 기능 |
|---|---|
| List Query Types | 온톨로지의 쿼리 유형을 페이지 단위로 조회합니다. |
| Get Query Type | API 이름으로 한 쿼리 유형을 조회합니다. |
| Execute Query | 쿼리에 입력을 전달하여 결과를 얻습니다. |
QueryType
| 필드 | 자료형 | 필수 여부 | 의미 |
|---|---|---|---|
apiName | string | 필수 | 쿼리 API 이름 |
description | string | 선택 | 쿼리 설명 |
displayName | string | 선택 | 화면 표시 이름 |
parameters | map<ParameterId, Parameter> | 선택 | 입력 정의 |
output | OntologyDataType | 선택 | 출력의 구조화된 자료형 |
rid | string | 필수 | 다른 Foundry API에서도 식별자로 사용할 수 있는 함수 RID |
version | string | 필수 | 함수 버전. <major>.<minor>.<patch>-<tag> 형식이며 태그는 생략 가능 |
버전 예시는 1.2.3, 1.2.3-rc1입니다. version은 조회한 함수의 메타데이터입니다.
Parameter의 필수 필드는 baseType과 required이고, 선택 필드는 description과 dataType입니다. baseType은 문자열 표현이며 dataType과 output은 type으로 구분하는 자료형 객체입니다. 23가지 변형과 재귀 필드는 매개변수와 값 자료형을 따릅니다.
가상 Employee 객체 참조 배열을 반환하는 출력 정의는 다음과 같습니다.
{
"type": "array",
"itemType": {
"type": "object",
"objectApiName": "Employee",
"objectTypeApiName": "Employee"
}
}
objectApiName과 objectTypeApiName은 각각 정의된 필드입니다. 객체 API 이름의 실제 대소문자를 유지합니다. 이 출력의 실행 결과는 DataValue 표현에 따라 객체 기본 키의 배열로 받을 수 있습니다.