쿼리 유형 조회(Get Query Type) (V1)

API 이름으로 쿼리의 입력과 출력 정의를 조회합니다. 쿼리 이름은 List Query Types나 Ontology Manager에서 확인합니다.

온톨로지 RID는 List Ontologies나 Ontology Manager에서 확인합니다. 쿼리 매개변수와 요청 본문은 없습니다.

응답은 QueryType입니다. apiName, 함수 rid, version은 필수이며 description, displayName, parameters, output은 선택 항목입니다. output은 자료형 객체이고 실제 쿼리 실행값은 별도의 Execute Query 응답에서 받습니다.

예시 쿼리는 필수 문자열 city를 받아 Employee 객체 참조 배열을 반환합니다. 함수 버전은 1.1.3-rc1입니다.

HTTP 요청

GET /api/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}

작업 식별자는 v1.getQueryType입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:ontologies-read 권한 범위가 필요합니다.

JSON 응답 예시

가상 온톨로지의 응답 예시입니다.

{
  "apiName": "getEmployeesInCity",
  "displayName": "Get Employees in City",
  "description": "Gets all employees in a given city",
  "parameters": {
    "city": {
      "baseType": "String",
      "description": "The city to search for employees in",
      "required": true
    }
  },
  "output": {
    "type": "array",
    "itemType": {
      "type": "object",
      "objectApiName": "Employee",
      "objectTypeApiName": "Employee"
    }
  },
  "rid": "ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b",
  "version": "1.1.3-rc1"
}

오류

실패 응답은 공통 API 오류의 형식으로 처리합니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 GetQueryTypeExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class GetQueryTypeExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity" `
	-Headers $headers

$response.content