온톨로지 쿼리 실행(Execute Query) (V1)

지정한 쿼리에 매개변수를 전달하여 실행합니다. 선택 매개변수는 요청에서 생략할 수 있습니다.

온톨로지 RID는 List Ontologies나 Ontology Manager에서 확인합니다. 쿼리 매개변수는 없고 ExecuteQueryRequest JSON 본문은 필수입니다. parameters에 필요한 항목은 쿼리 유형 정의를 따릅니다. 매개변수 ID는 Ontology Manager에서 관리하며, 값은 DataValue 형식으로 전달합니다.

ExecuteQueryResponse의 필수 value에는 DataValue 형식의 실행 결과가 들어갑니다. 예시 쿼리는 city: "New York"을 받아 직원 객체 참조 배열을 반환합니다. 응답의 문자열은 가상 직원의 기본 키이며, 객체의 모든 속성을 포함한 JSON 객체는 아닙니다.

HTTP 요청

POST /api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute

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

JSON 요청 예시

가상 쿼리에 전달하는 요청 예시입니다.

{
  "parameters": {
    "city": "New York"
  }
}

JSON 응답 예시

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

{
  "value": [
    "EMP546",
    "EMP609",
    "EMP989"
  ]
}

오류

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

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queries/getEmployeesInCity/execute" \
	-d '{"parameters":{"city":"New York"}}'

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "parameters": {
        "city": "New York"
    }
}

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

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class ExecuteQueryExample {
    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()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queries/getEmployeesInCity/execute");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"parameters\":{\"city\":\"New York\"}}", ContentType.APPLICATION_JSON));
            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/queries/getEmployeesInCity/execute`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"parameters":{"city":"New York"}}'
}).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/queries/getEmployeesInCity/execute" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"parameters`":{`"city`":`"New York`"}}"

$response.content