전역 쿼리 함수 실행(Execute Query) (V2)

온톨로지 범위가 없는 전역 쿼리 함수를 실행하고 결과를 JSON 객체 하나로 반환합니다. 온톨로지 범위의 함수에는 /api/v2/ontologies/{ontology}/queries/{queryApiName}/execute 경로를 사용합니다. 배치가 준비되는 대로 받으려면 스트리밍 실행을 사용합니다.

버전을 생략하면 기본적으로 사전 릴리스를 제외한 가장 높은 의미 버전을 실행합니다. PUBLISH_TIME을 지정한 최신 선택은 최근 게시 버전을 기준으로 하며 기본적으로 사전 릴리스도 포함합니다. includePrerelease를 명시적 version과 함께 보내지 않습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/functions/queries/{queryApiName}/execute

작업 식별자는 v2.executeQuery입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:functions-execute 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

ExecuteQueryRequest 본문은 필수입니다. 매개변수 ID와 JSON 값은 실행할 Query의 정의에 맞춰 준비합니다. branch와 version을 함께 지정했다면 해당 브랜치에 그 버전이 있어야 합니다.

parameters의 구조

맵의 키는 ParameterId(string), 값은 DataValue(any)입니다.

키: 액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

함수 입력이나 출력의 JSON 값입니다. 구조체 배열처럼 값이 중첩될 수 있습니다.

구체적인 JSON 표현과 중첩 값은 DataValue 인코딩을 따릅니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "latestVersionResolution": "PUBLISH_TIME",
  "parameters": {
    "price": 29.99
  },
  "version": "1.2.3",
  "branch": "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
}

응답

응답 형식은 ExecuteQueryResponse입니다.

ExecuteQueryResponse.value에 함수의 결과가 들어갑니다. 값 자체의 형식은 실제 Query의 output 정의를 따릅니다.

value의 구조

구체적인 JSON 표현과 중첩 값은 DataValue 인코딩을 따릅니다.

가상 가격 쿼리 결과의 응답 예시입니다.

{
  "value": 29.99
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

가상 가격 함수에 29.99를 전달하는 예제입니다. 실제 함수의 매개변수 자료형을 먼저 확인합니다. transaction-1과 브랜치 RID는 실제 지원 환경의 값으로 바꾸며, 실험적 트랜잭션을 사용하지 않으면 transactionId를 생략합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/functions/queries/myQueryFunction/execute?transactionId=transaction-1&preview=true" \
	-d '{"latestVersionResolution":"PUBLISH_TIME","parameters":{"price":29.99},"version":"1.2.3","branch":"ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"}'

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 = {
    "latestVersionResolution": "PUBLISH_TIME",
    "parameters": {
        "price": 29.99
    },
    "version": "1.2.3",
    "branch": "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
}

response = requests.post('https://{}/api/v2/functions/queries/myQueryFunction/execute?transactionId=transaction-1&preview=true'.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/v2/functions/queries/myQueryFunction/execute?transactionId=transaction-1&preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"latestVersionResolution\":\"PUBLISH_TIME\",\"parameters\":{\"price\":29.99},\"version\":\"1.2.3\",\"branch\":\"ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252\"}", 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/v2/functions/queries/myQueryFunction/execute?transactionId=transaction-1&preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"latestVersionResolution":"PUBLISH_TIME","parameters":{"price":29.99},"version":"1.2.3","branch":"ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/functions/queries/myQueryFunction/execute?transactionId=transaction-1&preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"latestVersionResolution`":`"PUBLISH_TIME`",`"parameters`":{`"price`":29.99},`"version`":`"1.2.3`",`"branch`":`"ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252`"}"

$response.content